Skip to content

docs(mcp-server): document the agentUrl option#12

Open
Scra3 wants to merge 2 commits into
mainfrom
docs/mcp-server-agent-url
Open

docs(mcp-server): document the agentUrl option#12
Scra3 wants to merge 2 commits into
mainfrom
docs/mcp-server-agent-url

Conversation

@Scra3

@Scra3 Scra3 commented Jul 7, 2026

Copy link
Copy Markdown
Member

What

Documents the new agent.mountAiMcpServer({ agentUrl }) option (code PR: ForestAdmin/agent-nodejs#1740).

By default, MCP tools call back into the agent's data layer over the environment's public api_endpoint — so the traffic leaves over the public internet even when the server is mounted in-process. agentUrl lets self-hosted deployments keep those callbacks on the internal network, without changing the advertised OAuth URLs (external MCP clients still authenticate normally).

Changes

  • reference/agent-api/nodejs.mdxagentUrl in the signature + param table, a dedicated "Keeping tool traffic on your internal network" section, a note on agentUrl vs basePath (outbound vs inbound), and the FOREST_AGENT_URL env var.
  • product/embed/mcp-server.mdx — a self-hosted <Note> in the Mounted section.

⚠️ Merge timing

agentUrl is not released yet — merge this after the code PR (ForestAdmin/agent-nodejs#1740) ships in a release.

🤖 Generated with Claude Code

Note

Document the agentUrl option for mountAiMcpServer in the MCP server reference

  • Adds a new optional agentUrl parameter to the mountAiMcpServer API docs in nodejs.mdx, describing how to override the default public backend URL for tool-to-agent callbacks.
  • Documents constraints: must be an http(s) URL with no query string or fragment; OAuth URLs always remain public regardless of this setting.
  • Adds a note clarifying that basePath and agentUrl are independent settings.
  • Updates mcp-server.mdx with a note about the FOREST_AGENT_URL environment variable for the standalone MCP server.

Macroscope summarized 4b14184.

Document mountAiMcpServer({ agentUrl }) — keeps the internal tool->agent
callbacks on a private network in self-hosted setups instead of the public
api_endpoint, without changing the advertised OAuth URLs. Adds the param, a
dedicated reference section, the FOREST_AGENT_URL env var, and a self-hosted
note on the product page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
forest 🟢 Ready View Preview Jul 7, 2026, 11:00 AM

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

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

2 participants