docs: add cheat sheet for MCP registry#540
Closed
subbyte wants to merge 2 commits intomodelcontextprotocol:mainfrom
Closed
docs: add cheat sheet for MCP registry#540subbyte wants to merge 2 commits intomodelcontextprotocol:mainfrom
subbyte wants to merge 2 commits intomodelcontextprotocol:mainfrom
Conversation
Member
|
Appreciate the spirit of this PR! Though I'm not sure about the mechanism -- our intent is to (eventually) merge all these docs into https://github.com/modelcontextprotocol/modelcontextprotocol/tree/main/docs and the Mintlify setup there, so anything beyond markdown files we add here would need to play nicely with Mintlify. So I would prefer that we stick to simple markdown files for now, but open to hearing other opinions. |
Contributor
Author
|
Good to hear the Minitlify version of doc is planned. I would be happy to help if you need ideas about organizing the docs or like the figures I created. We can easily publish the figure in svg or png for markdown use while keeping the source in TikZ for editablity. |
Member
|
I've been thinking, and I think this would be ideal for the recently added community resources section? You could spin this out into your own repo like subbyte/mcp-registry-cheatsheet and then link it from here? |
Contributor
Author
|
Thanks for the advise @domdomegg ! Will create another PR to add a line in |
9 tasks
Member
|
Superceded by #600 |
domdomegg
pushed a commit
that referenced
this pull request
Oct 2, 2025
<!-- Provide a brief summary of your changes --> Add the MCP registry cheat sheet project link in `/docs/community-projects.md` ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> It will be beneficial to have a cheat sheet that describes what are the spaces of docs, organizes the spaces, and provides references to detailed docs/guides/references. With such cheat sheet, new users would quickly navigate in different spaces and find what commands and docs they need. More discussion at #540 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> No test needed. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [ ] I have added appropriate error handling - [x] I have added or updated documentation as needed
slimslenderslacks
pushed a commit
to slimslenderslacks/registry
that referenced
this pull request
Dec 18, 2025
<!-- Provide a brief summary of your changes --> Add the MCP registry cheat sheet project link in `/docs/community-projects.md` ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> It will be beneficial to have a cheat sheet that describes what are the spaces of docs, organizes the spaces, and provides references to detailed docs/guides/references. With such cheat sheet, new users would quickly navigate in different spaces and find what commands and docs they need. More discussion at modelcontextprotocol#540 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> No test needed. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [ ] I have added appropriate error handling - [x] I have added or updated documentation as needed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Creating a one-page cheat sheet for various MCP registry users:
Motivation and Context
MCP registry is a project for multiple sets of users, e.g., MCP server publisher, MCP server consumer. For each type of users, there are multiple pointers/references in documentations to follow.
It will be beneficial to have a cheat sheet that describes what are the spaces of docs, organizes the spaces, and provides references to detailed docs/guides/references. With such cheat sheet, new users would quickly navigate in different spaces and find what commands and docs they need.
A picture is worth a thousand words, and it's best to have a cheat sheet with some type of visualization of personas and actions. To make the sheet succinct and editable, we'd better use well defined vector graphs with substructures for easy editing/extending. So I create the cheat sheet with TeX and PGF/TikZ.
How Has This Been Tested?
The compilation of the cheat sheet is tested both locally (MacTeX-2025) and on overleaf with no error/warning.
Types of changes
Checklist