fix README.md badges and blockquote icon - #2022
Conversation
|
@modelcontextprotocol/client
@modelcontextprotocol/codemod
@modelcontextprotocol/server
@modelcontextprotocol/express
@modelcontextprotocol/fastify
@modelcontextprotocol/hono
@modelcontextprotocol/node
commit: |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM — thanks for extending the alert-syntax fix to the package READMEs too.
Extended reasoning...
Overview
Documentation-only change across three READMEs: (1) splits GitHub alert markers (> [!IMPORTANT], > [!WARNING], > [!NOTE]) onto their own line so GitHub renders styled callouts instead of plain blockquotes with literal [!TYPE] text, guarded with <!-- prettier-ignore --> so prettier doesn't re-collapse them; (2) gives the two npm version badges distinguishing labels and wraps them in links to the respective npm package pages; (3) incidental prettier reformatting of the inline code sample (indentation/trailing commas) and one long line wrap.
Prior review
On the first revision I flagged that the same broken alert syntax survived in packages/client/README.md and packages/server/README.md. The author addressed this in commit bc93a74 — both package READMEs now apply the identical two-line split with prettier-ignore guards. A repo-wide grep for ^> [!TYPE] <text> confirms no remaining instances.
Security risks
None. No executable code, configuration, workflow, or dependency is touched — only Markdown prose, badge image URLs (shields.io) and links to npmjs.com.
Level of scrutiny
Low. Cosmetic README rendering fix with zero impact on the published package contents beyond the README text itself. No changeset is needed for a docs-only change. The badge URLs and npm links are correct for the @modelcontextprotocol/server and @modelcontextprotocol/client packages.
Other factors
The code-sample reformatting in the root README is mechanical prettier output (4-space indent, dropped trailing commas) and doesn't change the example's semantics. Nothing here touches API surface, schemas, transports, or CI.
There was a problem hiding this comment.
LGTM — thanks for also fixing the package READMEs; docs-only change with no code impact.
Extended reasoning...
Overview
This PR touches only Markdown files: README.md, packages/client/README.md, and packages/server/README.md. It splits GitHub alert markers (> [!IMPORTANT], > [!WARNING], > [!NOTE]) onto their own lines so they render as styled callouts, adds <!-- prettier-ignore --> guards to keep prettier from collapsing them, gives the npm badges descriptive labels and clickable links to the npm registry pages, and reformats the README code example to 4-space indentation matching the repo's prettier config.
Security risks
None. These are README/Markdown-only edits; no executable code, configuration, CI, or dependency changes.
Level of scrutiny
Low. Documentation-only, cosmetic rendering fix. No public API, transport behavior, or schema is touched. The badge URLs all point to the canonical img.shields.io and npmjs.com package pages.
Other factors
My earlier inline comment flagged that the same broken single-line alert syntax survived in the two package READMEs; the author has since pushed the fix there as well, so the migration is complete. The bug-hunting system found no issues. The PR has no changeset, which is correct since README changes don't require a version bump.
There was a problem hiding this comment.
LGTM — docs-only fix; the leftover alert-syntax sites I flagged in the package READMEs have now been addressed.
Extended reasoning...
Overview
This PR is documentation-only: it fixes GitHub alert (> [!TYPE]) blockquote syntax in README.md, packages/client/README.md, and packages/server/README.md so the callouts render with icons/colors; adds labels and links to the npm badges; and reformats the README code example to 4-space indentation with no trailing commas, matching the repo's .prettierrc (tabWidth: 4, trailingComma: "none"). <!-- prettier-ignore --> comments are added before the alert blocks.
Security risks
None. No code, configuration, or dependency changes — Markdown only.
Level of scrutiny
Low. These are cosmetic Markdown fixes with no behavioral surface. The bug-hunting system found no issues.
Other factors
My earlier inline comment flagged that the same broken single-line alert syntax survived in the two package READMEs; the current diff now applies the identical fix there, so that concern is resolved. The badge URL changes point to the correct npm package pages. No changeset is needed for README-only changes.
2 participants
Motivation and Context
How Has This Been Tested?
Breaking Changes
Types of changes
Checklist
Additional context