docs: add MCPToolProvider documentation#567
Conversation
Adds a dedicated page for MCPToolProvider covering both Python and TypeScript, with sections for stdio/SSE transports, multiple servers, agent compatibility, and a full configuration reference. Updates the sidebar to expand 'Tools for Agents' into a section. Closes #299 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 89675c2366
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <Tabs syncKey="runtime"> | ||
| <TabItem label="TypeScript" icon="seti:typescript" color="blue"> | ||
| ```typescript | ||
| import { AgentSquad, BedrockLLMAgent, MCPToolProvider } from "agent-squad"; |
There was a problem hiding this comment.
Don't document an unexported MCPToolProvider
This new page is linked from the Python/TypeScript docs, but the feature it introduces is not present in either package: typescript/src/index.ts does not export MCPToolProvider and there is no implementation under typescript/src, while the Python package has no agent_squad.tools module and no mcp extra in setup.cfg. Users copying the first install/import examples will fail immediately, so please add the implementation/exports and packaging metadata in the same release or remove this page from the Python/TypeScript docs until it exists.
Useful? React with 👍 / 👎.
| name: "openai-agent", | ||
| description: "Agent with MCP tools", | ||
| apiKey: process.env.OPENAI_API_KEY!, | ||
| toolConfig: { tool: mcpTools }, |
There was a problem hiding this comment.
Don't advertise OpenAI toolConfig support
This OpenAI example cannot work even if the MCP provider exists: OpenAIAgentOptions in both TypeScript and Python only extends the base AgentOptions and the OpenAI agent implementations never accept, format, or invoke toolConfig/tool_config. In the TypeScript snippet this is an excess property compile error, and in Python it is an unexpected dataclass argument, so the section should be limited to agents that actually support tools or the OpenAI tool path needs to be implemented first.
Useful? React with 👍 / 👎.
Review of Codex's assessmentNote on verification: I wasn't able to fetch the diffs of #565 or #566 directly — network access ( Codex's two points are both accurate against the current codebase:
Given that #565 (Python) and #566 (TypeScript) exist: this changes the framing but not the underlying risk. Codex's review only sees this PR's branch, and (as far as I can verify locally)
Recommendation:
I haven't made any code changes — this was a review-only request. Let me know if you'd like me to adjust the doc (e.g., remove/caveat the OpenAI section, or add a "requires #565/#566" note) once you confirm the merge plan. |
Issue Link (REQUIRED)
Fixes #299
Summary
Changes
Adds documentation for the new
MCPToolProvidershipped in #565 (Python) and #566 (TypeScript).docs/src/content/docs/agents/mcp-tool-provider.mdxMCPServerConfigandMCPToolProviderdocs/astro.config.mjs: expands the "Tools for Agents" sidebar entry into a section with an Overview link and the new MCP Tool Provider pageUser experience
Before: no docs for MCP support.
After: users can find the MCP Tool Provider page under Tools for Agents → MCP Tool Provider in the sidebar, with working copy-paste examples for both languages.
Checklist
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.