Skip to content

Generate README.md tools section from schema #223

@williammartin

Description

@williammartin
Collaborator

Description

It's very easy for the README Tools section to get out of date with the real schema.

#221
#205 (review)

Suggestion

Include a script in the repository that uses the MCP Server schema to produce the README tools section contents. I'm hoping we can get access to this somehow without starting the server and sending an list tools request. Maybe this could go into upstream mcp-go as a utility.

In CI, generate this file and compare to the contents of the tools section in the PR, if there is a diff then error with guidance on how to run the script.

Activity

SamMorrowDrums

SamMorrowDrums commented on Apr 13, 2025

@SamMorrowDrums
Collaborator

Maybe this could go into upstream mcp-go as a utility.

That would be phenomenal generally, but would be amazing for us regardless.

LuluBeatson

LuluBeatson commented on Jul 16, 2025

@LuluBeatson
Contributor

Thank you all

We now have auto-generated docs of all the tools grouped by toolset in the README.md under "Tools".
Also this docs page "Remote Server" describes how to filter the Remote MCP by toolset.

For contributors, if you edit tool descriptions, arguments or add new tools, please run this script to update the auto-generated docs

script/generate-docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @williammartin@SamMorrowDrums@tonytrg@LuluBeatson

      Issue actions

        Generate README.md tools section from schema · Issue #223 · github/github-mcp-server