Skip to content

Connect your agent

Your agent reaches OpenMarkdown through its MCP server, openmd mcp. It is the app you already installed, answering over stdio: nothing new is downloaded and nothing goes over the network. Connect once per agent.

This works on macOS and Linux. Agents in your own terminal also need the command-line tool turned on.

On macOS and Linux, the quickest way is the app itself. Press ⇧⌘A to open the intercom: it lists the agents installed on this computer, one row each. A row that still needs OpenMarkdown says so under its name. Clicking it connects OpenMarkdown in the sidebar terminal, then starts the agent:

  • Claude Code: installs the plugin (the two commands under Claude Code below).
  • Codex: registers the MCP server (codex mcp add openmd -- openmd mcp).

See what runs shows the exact commands before you click, with how to remove them. Gemini CLI and opencode start as they are: connect them by hand below first.

For an agent you run in your own terminal, paste this to it (any agent that can read a web page):

Read openmarkdown.dev/install to install OpenMarkdown and open my first note

It checks that openmd is there, connects itself, and opens your Welcome note. If openmd is missing, it stops and tells you what to turn on. The same sentence is in the app under Settings → Connect your agent.

Or connect by hand:

Claude Code gets the full plugin: the MCP tools plus a skill and slash commands that teach it when to use them.

Terminal window
claude plugin marketplace add OpenMarkdown-dev/OpenMarkdown-releases
claude plugin install openmarkdown@openmarkdown

The plugin is Markdown only: no hooks, no scripts that run on their own, no network calls. Read its source before you install it if you like.

Tools only, without the skill:

Terminal window
claude mcp add openmd -- openmd mcp
Terminal window
codex mcp add openmd -- openmd mcp

Or in ~/.codex/config.toml:

[mcp_servers.openmd]
command = "openmd"
args = ["mcp"]
Terminal window
gemini mcp add openmd openmd mcp

Or in ~/.gemini/settings.json:

{ "mcpServers": { "openmd": { "command": "openmd", "args": ["mcp"] } } }

In opencode.json (one project) or ~/.config/opencode/opencode.json (everywhere):

{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"openmd": { "type": "local", "command": ["openmd", "mcp"], "enabled": true }
}
}

Have it start openmd mcp over stdio, with no arguments:

{ "command": "openmd", "args": ["mcp"] }

Agents other than Claude Code get the MCP tools and no skill; their tool descriptions say when to use each one.

Ask your agent:

What do I have open in OpenMarkdown?

It should name your open folder and file. If it says OpenMarkdown is not running, open the app and ask again. More in Troubleshooting.