Skip to content

docs: use Responses API in README MCP examples#436

Open
mvanhorn wants to merge 1 commit into
MacPaw:mainfrom
mvanhorn:fix/389-readme-mcp-responses-api
Open

docs: use Responses API in README MCP examples#436
mvanhorn wants to merge 1 commit into
MacPaw:mainfrom
mvanhorn:fix/389-readme-mcp-responses-api

Conversation

@mvanhorn

@mvanhorn mvanhorn commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

What

Updates the README's Remote MCP examples to use the Responses API (CreateModelResponseQuery + openAI.responses.createResponse) instead of ChatQuery, and adds a note that MCP tools are a Responses API feature not supported by Chat Completions.

Why

The current MCP examples don't compile: Tool.mcpTool only fits the Responses API's tools parameter, while ChatQuery.tools accepts function tools only, so copying the README snippet produces a type error (#389). The corrected snippets compile against current main.

Affected Areas

README.md only. No library code changes.

Fixes #389

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.

[Bug] Compilation Error: Cannot convert 'Tool' to 'ChatQuery.ChatCompletionToolParam' when using MCP Tooling

1 participant