-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Docs: align CLI, deployment, fastmcp.json, and contributor workflow behavior #4256
Copy link
Copy link
Open
Labels
cliRelated to FastMCP CLI commands (run, dev, install) or CLI functionality.Related to FastMCP CLI commands (run, dev, install) or CLI functionality.documentationUpdates to docs, examples, or guides. Primary change is documentation-related.Updates to docs, examples, or guides. Primary change is documentation-related.fastmcp.jsonFunctionality related to fastmcp.json or FastMCPConfig files.Functionality related to fastmcp.json or FastMCPConfig files.httpRelated to HTTP transport, networking, or web server functionality.Related to HTTP transport, networking, or web server functionality.
Metadata
Metadata
Assignees
Labels
cliRelated to FastMCP CLI commands (run, dev, install) or CLI functionality.Related to FastMCP CLI commands (run, dev, install) or CLI functionality.documentationUpdates to docs, examples, or guides. Primary change is documentation-related.Updates to docs, examples, or guides. Primary change is documentation-related.fastmcp.jsonFunctionality related to fastmcp.json or FastMCPConfig files.Functionality related to fastmcp.json or FastMCPConfig files.httpRelated to HTTP transport, networking, or web server functionality.Related to HTTP transport, networking, or web server functionality.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Several CLI/deployment/config/contributor docs describe old behavior, which makes copy-pasted examples fail or teach the wrong defaults.
Concrete drift found in the docs audit:
fastmcp callcan call tools, read resource URIs, and render prompts with--prompt, but the CLI docs only describe tool calls.--server-name,-e, and-f; current install commands expose--name/-n,--with-editable, and--env-file.3000and/mcp/; runtime defaults are port8000, Streamable HTTP path/mcp, and SSE path/sse.fastmcp.jsonwhen no path is supplied.streamable-httpis accepted as a config alias and normalized tohttp, which should be documented consistently.uv run pytestwhere the repo guidance expectsuv run pytest -n auto, and the contrib guide should reflect the issue-first workflow for in-repo contrib modules.Expected: the CLI, deployment, config, and contributor workflow docs should match current command flags, runtime defaults, config-file loading behavior, and repo contribution guidance.
Verified against current code, repo guidance, and tests:
AGENTS.md/CLAUDE.mdCONTRIBUTING.mdfastmcp_slim/fastmcp/cli/client.pyfastmcp_slim/fastmcp/cli/install/*fastmcp_slim/fastmcp/settings.pyfastmcp_slim/fastmcp/server/mixins/transport.pyfastmcp_slim/fastmcp/utilities/mcp_server_config/v1/mcp_server_config.pytests/cli/*A focused local validation pass for the candidate docs updates passed: docs examples, broken links, prek, and CLI tests.