Skip to content

fix README.md badges and blockquote icon#2022

Open
KKonstantinov wants to merge 4 commits intomainfrom
fix/readme-npm-badges-blockquote
Open

fix README.md badges and blockquote icon#2022
KKonstantinov wants to merge 4 commits intomainfrom
fix/readme-npm-badges-blockquote

Conversation

@KKonstantinov
Copy link
Copy Markdown
Contributor

Motivation and Context

How Has This Been Tested?

Breaking Changes

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

Additional context

@KKonstantinov KKonstantinov requested a review from a team as a code owner May 6, 2026 05:22
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2026

⚠️ No Changeset found

Latest commit: 0ffcde5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 6, 2026

Open in StackBlitz

@modelcontextprotocol/client

npm i https://pkg.pr.new/@modelcontextprotocol/client@2022

@modelcontextprotocol/server

npm i https://pkg.pr.new/@modelcontextprotocol/server@2022

@modelcontextprotocol/express

npm i https://pkg.pr.new/@modelcontextprotocol/express@2022

@modelcontextprotocol/fastify

npm i https://pkg.pr.new/@modelcontextprotocol/fastify@2022

@modelcontextprotocol/hono

npm i https://pkg.pr.new/@modelcontextprotocol/hono@2022

@modelcontextprotocol/node

npm i https://pkg.pr.new/@modelcontextprotocol/node@2022

commit: 0ffcde5

Comment thread README.md
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

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.

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.

1 participant