docs(mcp-server): document the agentUrl option - #12
Open
Scra3 wants to merge 3 commits into
Open
Conversation
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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ShohanRahman
approved these changes
Jul 7, 2026
agentUrl is no longer a mountAiMcpServer option (mounted mode dispatches tool calls in-process). Document it only as the standalone server's FOREST_AGENT_URL env var. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.agentUrllets 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.mdx—agentUrlin the signature + param table, a dedicated "Keeping tool traffic on your internal network" section, a note onagentUrlvsbasePath(outbound vs inbound), and theFOREST_AGENT_URLenv var.product/embed/mcp-server.mdx— a self-hosted<Note>in the Mounted section.agentUrlis not released yet — merge this after the code PR (ForestAdmin/agent-nodejs#1740) ships in a release.🤖 Generated with Claude Code
Note
Document the
agentUrloption formountAiMcpServerin the MCP server referenceagentUrlparameter to themountAiMcpServerAPI docs in nodejs.mdx, describing how to override the default public backend URL for tool-to-agent callbacks.http(s)URL with no query string or fragment; OAuth URLs always remain public regardless of this setting.basePathandagentUrlare independent settings.FOREST_AGENT_URLenvironment variable for the standalone MCP server.Changes since #12 opened
agentUrloption fromagent.mountAiMcpServermethod [de6b943]agentUrlconfiguration guidance withFOREST_AGENT_URLenvironment variable documentation [de6b943]Macroscope summarized 4b14184.