Skip to content

docs: add missing space after period in MCPServerStdio docstring#3053

Merged
seratch merged 1 commit intoopenai:mainfrom
GopalGB:gb-fix/docstring-typos
Apr 30, 2026
Merged

docs: add missing space after period in MCPServerStdio docstring#3053
seratch merged 1 commit intoopenai:mainfrom
GopalGB:gb-fix/docstring-typos

Conversation

@GopalGB
Copy link
Copy Markdown
Contributor

@GopalGB GopalGB commented Apr 30, 2026

Summary

MCPServerStdio.__init__ (src/agents/mcp/server.py line 236) had a missing space in the use_structured_content parameter docstring:

-                MCP tool.Defaults to False for backwards compatibility - most MCP servers still
+                MCP tool. Defaults to False for backwards compatibility - most MCP servers still

The four sibling occurrences in the same file (lines 513, 1083, 1206, 1342) already had the correct spacing, so this stdio variant was the outlier.

Why

Editors that surface docstrings on hover (Pylance, Pyright, Jedi, IDE tooltips) render the two sentences as one when the space is missing. Bringing the stdio class docstring in line with the rest also makes the file self-consistent.

How to test

$ grep -c 'MCP tool\.Defaults' src/agents/mcp/server.py
0
$ grep -c 'MCP tool\. Defaults' src/agents/mcp/server.py
5

No behavioral change — pure documentation edit.

Checklist

  • No code logic changed
  • Other 4 sibling docstrings already had the correct spacing — this PR only touches the one outlier
  • No tests needed (docstring-only change)

`MCPServerStdio.__init__` (line 236 of src/agents/mcp/server.py) had a
missing space after a period in the `use_structured_content` docstring:
"MCP tool.Defaults to False ...". The four sibling MCP server classes
(MCPServerSse, MCPServerStreamableHttp, etc.) already had correct
spacing — this PR brings the stdio variant in line.

Editors that surface docstrings on hover (Pylance, Pyright, Jedi)
render the two sentences correctly after this fix.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@seratch seratch added the documentation Improvements or additions to documentation label Apr 30, 2026
@seratch seratch merged commit 3a3f34f into openai:main Apr 30, 2026
10 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 feature:mcp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants