Skip to content

docs: add missing space in MCP params docstrings#3535

Merged
seratch merged 1 commit into
openai:mainfrom
jluocsa:docs/fix-mcp-params-docstring-space
May 31, 2026
Merged

docs: add missing space in MCP params docstrings#3535
seratch merged 1 commit into
openai:mainfrom
jluocsa:docs/fix-mcp-params-docstring-space

Conversation

@jluocsa
Copy link
Copy Markdown
Contributor

@jluocsa jluocsa commented May 31, 2026

Summary

The class docstrings for MCPServerSseParams and MCPServerStreamableHttpParams are missing a space before the backtick:

# before
"""Mirrors the params in`mcp.client.sse.sse_client`."""
"""Mirrors the params in`mcp.client.streamable_http.streamablehttp_client`."""

# after
"""Mirrors the params in `mcp.client.sse.sse_client`."""
"""Mirrors the params in `mcp.client.streamable_http.streamablehttp_client`."""

Without the space the inline code reference does not render as intended in generated docs. Two-line, docs-only change.

Checks

  • ruff check src/agents/mcp/server.py — passes
  • ruff format --check src/agents/mcp/server.py — already formatted

The class docstrings for MCPServerSseParams and
MCPServerStreamableHttpParams read "Mirrors the params in`mcp...`",
with no space before the backtick. Add the space so the inline code
reference renders correctly.
@seratch seratch added the documentation Improvements or additions to documentation label May 31, 2026
@seratch seratch enabled auto-merge (squash) May 31, 2026 05:03
@seratch seratch merged commit 464043a into openai:main May 31, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants