-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Docs: align client, MCP Apps, OpenAPI, and auth integration examples with current APIs #4258
Copy link
Copy link
Open
Labels
authRelated to authentication (Bearer, JWT, OAuth, WorkOS) for client or server.Related to authentication (Bearer, JWT, OAuth, WorkOS) for client or server.clientRelated to the FastMCP client SDK or client-side functionality.Related to the FastMCP client SDK or client-side functionality.documentationUpdates to docs, examples, or guides. Primary change is documentation-related.Updates to docs, examples, or guides. Primary change is documentation-related.integrationmcp appsRelated to MCP Apps - user-facing applications with frontend bundles served by MCP servers.Related to MCP Apps - user-facing applications with frontend bundles served by MCP servers.openapiRelated to OpenAPI integration, parsing, or code generation features.Related to OpenAPI integration, parsing, or code generation features.tasksRelated to background tasks, Docket, SEP-1686.Related to background tasks, Docket, SEP-1686.
Metadata
Metadata
Assignees
Labels
authRelated to authentication (Bearer, JWT, OAuth, WorkOS) for client or server.Related to authentication (Bearer, JWT, OAuth, WorkOS) for client or server.clientRelated to the FastMCP client SDK or client-side functionality.Related to the FastMCP client SDK or client-side functionality.documentationUpdates to docs, examples, or guides. Primary change is documentation-related.Updates to docs, examples, or guides. Primary change is documentation-related.integrationmcp appsRelated to MCP Apps - user-facing applications with frontend bundles served by MCP servers.Related to MCP Apps - user-facing applications with frontend bundles served by MCP servers.openapiRelated to OpenAPI integration, parsing, or code generation features.Related to OpenAPI integration, parsing, or code generation features.tasksRelated to background tasks, Docket, SEP-1686.Related to background tasks, Docket, SEP-1686.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Several client-facing and integration docs describe stale API behavior or examples. The issues are docs-only, but they affect high-copy-paste areas: client task handling, MCP Apps routing, OpenAPI request construction, and auth provider setup examples.
Concrete drift found in the docs audit:
input_requiredstatus and understate howtask.wait()behaves when a task leavesworking.CallToolResult.data, raw MCP results viacall_tool_mcp, resource version reads, cancellation notifications, and resource-updated notifications._meta.fastmcp.approuting path; current app tools use deterministic hashed backend names and per-tool Prefab renderer resources.None, while empty strings remain explicit empty query values.base_url,environment_url,resource_id, optionalrequired_scopes, and a JWT verifier configured from those values.Expected: client, apps, OpenAPI, and auth integration docs should match current public APIs and request-routing behavior so copied examples run as written.
Verified against current code and tests:
fastmcp_slim/fastmcp/client/client.pyfastmcp_slim/fastmcp/client/messages.pyfastmcp_slim/fastmcp/client/tasks.pyfastmcp_slim/fastmcp/client/mixins/resources.pyfastmcp_slim/fastmcp/apps/app.pyfastmcp_slim/fastmcp/server/providers/prefab_synthesis.pyfastmcp_slim/fastmcp/server/server.pyfastmcp_slim/fastmcp/utilities/openapi/director.pyfastmcp_slim/fastmcp/server/auth/providers/scalekit.pytests/client/*tests/server/tasks/*tests/utilities/openapi/test_director.pytests/server/auth/providers/test_scalekit.pyA focused local validation pass for the candidate docs updates passed: docs examples, broken links, prek, and client/task/OpenAPI/auth-provider tests.