Skip to content

docs: Fix markdown formatting and file references #4096 - #4097

Closed
0xnithinmys wants to merge 1 commit into
modelcontextprotocol:mainfrom
0xnithinmys:docs/fix-markdown-and-references-4096
Closed

0xnithinmys wants to merge 1 commit into
modelcontextprotocol:mainfrom
0xnithinmys:docs/fix-markdown-and-references-4096

Conversation

@0xnithinmys

Copy link
Copy Markdown

Description

This pull request addresses several formatting and referential bugs found within the Everything MCP server documentation.

These documentation errors were breaking the rendering of the README.md on GitHub/NPM and providing confusing or mislabeled file references to developers.

Changes Made

  1. Broken Markdown Rendering in README.md

    • Fix: Fixed a markdown syntax error in src/everything/README.md where an installation code block was closed with 4 backticks (````) instead of 3 (```), which was breaking the remainder of the markdown rendering on the page.
  2. Incorrect Tool Filename in features.md

    • Fix: Corrected the typo for the long-running operation tool in src/everything/docs/features.md. Changed tools/trigger-trigger-long-running-operation.ts to tools/trigger-long-running-operation.ts.
  3. Mislabeled Instructions File (startup.md & structure.md)

    • Fix: Updated references in src/everything/docs/startup.md and src/everything/docs/structure.md from server-instructions.md to instructions.md to match the actual file name.
  4. Self-Referential Errors in structure.md

    • Fix: Cleaned up the docs/ folder outline in src/everything/docs/structure.md:
      • Labeled architecture.md properly as "Architectural overview."
      • Added structure.md to the tree and correctly labeled it as "This document."
      • Updated the instructions document reference to instructions.md.

Related Issues

Fixes #4096

Testing

  • Verified that markdown renders correctly in IDE previews.
  • Verified all mentioned file paths accurately reflect the repository's file structure.

@cliffhall cliffhall added the closed-superseded-v2 Closed: fixed or made obsolete by the v2 / 2026-07-28 refactor (#4875) label Oct 20, 2026
@cliffhall

Copy link
Copy Markdown
Member

Thank you for this pull request, and apologies for the long wait for a response.

Since it was opened, the reference servers have been rebuilt for the 2026-07-28 MCP specification (#4857) and released as v2 (2.0.0 on npm for the TypeScript servers, 2026.10.19 on PyPI for the Python servers). The code this PR changes has been replaced, and the behavior it addresses has either been fixed in v2 or no longer exists in the same form.

This is not a judgment on the change or on you; it's a consequence of the code it targets having been replaced. If the problem still happens on v2, please open a fresh issue with the version you're running and steps to reproduce. Note that this repository now accepts contributions as issues rather than pull requests from anyone but its maintainers; see CONTRIBUTING.md.

This is part of the backlog triage in #4875.

@cliffhall cliffhall closed this Oct 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

closed-superseded-v2 Closed: fixed or made obsolete by the v2 / 2026-07-28 refactor (#4875)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Fix markdown formatting and file references

2 participants