Skip to content

docs(mcp): configure MCP servers in Agent Canvas; move config.toml [mcp] to V0 reference - #846

Open
rajshah4 wants to merge 1 commit into
mainfrom
docs/mcp-settings-agent-canvas
Open

rajshah4 wants to merge 1 commit into
mainfrom
docs/mcp-settings-agent-canvas

Conversation

@rajshah4

Copy link
Copy Markdown
Member
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

The MCP settings page says MCP servers can be defined "in the config.toml file under the [mcp] section if not using the UI". All of its configuration examples use sse_servers / shttp_servers / stdio_servers TOML. Current OpenHands doesn't read that section; TOML-based MCP config was removed in OpenHands/OpenHands#14241. Third-party integrations are following the stale page. For example, hindsight-openhands init writes the Hindsight MCP server to ./config.toml, so Agent Canvas users get no Hindsight tools.

openhands/usage/settings/mcp-settings.mdx:

  • Configuration now says where MCP servers live for each surface:
    • Agent Canvas: Customize > MCP Servers
    • CLI: openhands mcp add / ~/.openhands/mcp.json
    • SDK: mcp_config
  • New <Warning>: config.toml [mcp] is ignored by current releases, with a link to the V0 reference.
  • New Add a Custom Server procedure (Add custom server → Server Type → fields → Test connection → save). It includes a note that local Agent Canvas stores servers in its settings store (~/.openhands/settings.json by default) with encrypted credentials, and that there's no per-project MCP file.
  • Server Fields tabs (SHTTP / SSE / STDIO) now use the real form labels: Server name, URL, Authentication (None / Bearer token / Header / OAuth), API Key, Headers, Timeout (seconds) (SHTTP only), Name, Command, Command Arguments, Environment Variables.
  • Configuration Examples: the SuperGateway and direct stdio examples are now Add custom server field tables instead of TOML, plus a note about localhost reachability from Docker or a remote sandbox.
  • New Documenting an Integration for OpenHands section for MCP server authors. It says to give the Add custom server values and the CLI command, not a config.toml [mcp] section, and to put standing agent instructions in AGENTS.md.
  • How MCP Works: servers load when a conversation starts; changes apply to new conversations.
  • OAuth: the Config File (TOML) tab is replaced with an Agent Canvas tab (Marketplace install, or Authentication: OAuth on a custom server).

openhands/usage/v0/advanced/V0_configuration-options.mdx:

  • New MCP Configuration section that keeps the legacy [mcp] TOML reference and example for V0 users, with a note pointing to the current page.

Verification

  • Field and navigation labels checked against Agent Canvas 1.24.0: the en locale plus extensions-navigation (MCP Servers), routes/mcp (Add custom server) and mcp-server-form (per-type fields).
  • Tested end to end on a local Agent Canvas (agent-server 1.49.6):
    • Servers listed in a project config.toml [mcp] were not loaded.
    • The same server added through the settings API worked: POST /api/mcp/test returned ok with its tools, and the agent called those tools in a conversation.
  • mint broken-links: no broken links. mint broken-links --check-anchors: the same 20 findings as main, none on these pages.
  • Rendered locally with mint dev; the tabs and tables display correctly.
  • llms.txt / llms-full.txt are not regenerated here. Running the generator picks up a lot of unrelated drift, so I left that to the weekly sync workflow.

This PR was created by an AI agent (OpenHands) on behalf of @rajshah4.

…cp] to V0 reference

The MCP settings page still said MCP servers can be defined in config.toml
[mcp] (sse_servers/shttp_servers/stdio_servers) and used TOML for all
examples. Current OpenHands no longer reads that section (removed in
OpenHands/OpenHands#14241), and third-party integrations have followed the
stale instructions (e.g. hindsight-openhands writes ./config.toml).

- Document Customize > MCP Servers > Add custom server with the actual
  Agent Canvas form fields (Server Type, URL, Authentication, Timeout,
  Command Arguments, Environment Variables) and Test connection
- Point CLI users to ~/.openhands/mcp.json and SDK users to mcp_config
- Warn that config.toml [mcp] is ignored; add guidance for tool authors
- Replace the OAuth 'Config File' tab with an Agent Canvas tab
- Preserve the legacy TOML reference in V0 configuration options

Co-authored-by: openhands <openhands@all-hands.dev>
@mintlify

mintlify Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
all-hands-ai 🟢 Ready View Preview Sep 26, 2026, 9:35 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — 1f930c88 Deployed Sep 26, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant