Skip to content

Merge user & specification documentation#283

Merged
jspahrsummers merged 444 commits intomainfrom
justin/merge-docs
Apr 8, 2025
Merged

Merge user & specification documentation#283
jspahrsummers merged 444 commits intomainfrom
justin/merge-docs

Conversation

@jspahrsummers
Copy link
Copy Markdown
Member

@jspahrsummers jspahrsummers commented Apr 7, 2025

This PR incorporates the contents of https://github.com/modelcontextprotocol/docs into this repo, so we have one source of truth for all "user" documentation as well as specification docs. I've included the other repo via a Git subtree, so as to not lose the contribution history.

The docs have been converted from Hugo/Hextra format into Mintlify MDX, as it has nicer rendering and comes with autogenerated https://modelcontextprotocol.io/llms-full.txt (very useful for LLMs helping with MCP stuff!).

Reading the diff will basically be impossible. Instead, see https://mcp-staging.mintlify.app/specification for the rendered version.

To do

After merging

  • Set up redirect from https://spec.modelcontextprotocol.io to the new pages
  • Notify issues, PRs, etc. on the docs repo about the change (difficult to do in bulk)
  • Archive the docs repo
  • Rename this repo to modelcontextprotocol/modelcontextprotocol?

zckly and others added 30 commits December 6, 2024 15:35
…protocol/docs into zack-lee/quickstart-updates
…updates

Phase 1 of documentation revamp: new Quickstart, servers, etc
@jspahrsummers jspahrsummers marked this pull request as ready for review April 7, 2025 16:38
@jspahrsummers jspahrsummers requested a review from a team April 7, 2025 16:38
@dsp-ant
Copy link
Copy Markdown
Member

dsp-ant commented Apr 8, 2025

This is great. I love the new layout. One sidenote: Maybe we want to use https://mintlify.com/docs/navigation/versions in the longrun for the spec, but for now let's just get it merged?

Copy link
Copy Markdown
Member

@dsp-ant dsp-ant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for doing this!

@jspahrsummers jspahrsummers merged commit 1aadf08 into main Apr 8, 2025
5 checks passed
@jspahrsummers jspahrsummers deleted the justin/merge-docs branch April 8, 2025 13:16
@jspahrsummers
Copy link
Copy Markdown
Member Author

@jonathanhefner jonathanhefner mentioned this pull request Jun 2, 2025
9 tasks
jonathanhefner added a commit to jonathanhefner/modelcontextprotocol that referenced this pull request Jun 5, 2025
Most `*.md` files were converted to `*.mdx` in modelcontextprotocol#283, but `package.json`
scripts and CI config were not updated to match.  This commit makes the
necessary updates.

Unfortunately, Prettier currently only supports MDX v1 (see
[prettier#15221][] and [prettier#12209][]), which causes it to treat
content inside JSX tags as JSX instead of Markdown unless the content is
surrounded by blank lines (see [prettier#16589][]).  Therefore, this
commit also adds blank lines inside JSX elements where necessary.

This commit also removes the 89-character line wrap rule for `.md` files
rather than update it for `.mdx` files.  It's not clear that the rule
was helpful, and we already have many files that do not abide by it:

  ```console
  $ grep -l '.{90}' docs/**/*.mdx | wc -l
  59
  ```

For ease of rebasing, this commit _does not_ actually format the files
using Prettier.  That will be done in the next commit.

[prettier#15221]: prettier/prettier#15221
[prettier#12209]: prettier/prettier#12209
[prettier#16589]: prettier/prettier#16589
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.