Skip to content

[Doc] Reorganize README to surface key information earlier#298

Merged
koic merged 3 commits intomodelcontextprotocol:mainfrom
koic:doc_restructure
Apr 5, 2026
Merged

[Doc] Reorganize README to surface key information earlier#298
koic merged 3 commits intomodelcontextprotocol:mainfrom
koic:doc_restructure

Conversation

@koic
Copy link
Copy Markdown
Member

@koic koic commented Apr 5, 2026

Motivation and Context

While working on #295 and #297, it became clear that the current README.md does not surface the information users are likely looking for at the top. As a result, I have reorganized the overall structure from a user’s perspective.

There is likely still room for further improvements, but even at this stage, the structure should be more useful than before.

This PR intentionally splits the changes into three commits.

  1. Custom methods are an advanced feature and may not be appropriate for the top of the README.md. Move them to the bottom of the page.
  2. Users are more likely to want to see Usage first, rather than a feature introduction like Sampling. Sampling has been moved below Resource Templates so that Usage appears at the top.
  3. For Usage, stdio is easier to try first than a Rails controller. Moved stdio to the top and placed Rails Controller after it.

Only sections were reorganized with headings. No content was changed.

Types of changes

  • 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)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

koic added 3 commits April 5, 2026 13:29
Custom methods are an advanced feature and may not be appropriate for the top of the README.md.
Move them to the bottom of the page.

Only sections were reorganized with headings. No content was changed.
Users are more likely to want to see Usage first, rather than a feature introduction like Sampling.
Sampling has been moved below Resource Templates so that Usage appears at the top.

Only sections were moved. No content was changed.
For Usage, stdio is easier to try first than a Rails controller.
Moved stdio to the top and placed Rails Controller after it.

Only sections were moved. No content was changed.
@koic
Copy link
Copy Markdown
Member Author

koic commented Apr 5, 2026

It would be easier to resolve conflicts if this is merged before #295, #297, and #299.

@koic koic merged commit 2a1c9b7 into modelcontextprotocol:main Apr 5, 2026
11 checks passed
@koic koic deleted the doc_restructure branch April 5, 2026 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants