mcp-tool-docstring

To format Python docstrings for MCP tools, include a one-line description, arguments, return values, and usage notes. This standardized format ensures the mcp-to-skills sync pipeline correctly maps the first line to the skill description and the rest to the body content.

Your MCP tool docstring may not display correctly if it lacks the required multi-section format. The sync pipeline parses the first line as the skill description and remaining sections as body content, so missing arguments or return value sections cause incomplete agent interface mapping.

The mcp-to-skills sync pipeline is a process that maps Python docstrings from @mcp.tool() functions to agent skill metadata. You need it when adding or updating system MCP tools to ensure they are correctly interpreted and displayed by the Skill Pilot agent interface.

No external dependencies are required to standardize MCP tool docstrings for the sync pipeline. You only need to follow the specified multi-section docstring format with a one-line description, arguments, return values, and usage notes when writing or updating your Python @mcp.tool() functions.

A docstring for an @mcp.tool() function requires a one-line description, an arguments section, a return values section, and usage notes. These sections ensure the mcp-to-skills sync pipeline accurately maps the content to the agent skill description and body.

You must follow the standardized multi-section docstring structure for MCP tools. Custom formats risk breaking the mcp-to-skills sync pipeline, which expects a one-line description, arguments, return values, and usage notes to correctly generate agent skill metadata.