Skip to content

Streamline README and add conformance score badges#312

Merged
chr-hertel merged 1 commit into
mainfrom
readme-badges-conformance-score
May 18, 2026
Merged

Streamline README and add conformance score badges#312
chr-hertel merged 1 commit into
mainfrom
readme-badges-conformance-score

Conversation

@chr-hertel
Copy link
Copy Markdown
Member

@chr-hertel chr-hertel commented May 17, 2026

What

Aligns the README with the other official MCP SDKs (C#, Python, TypeScript, Go) and surfaces a live conformance score.

README

  • Adds a centered shields.io badge row to the header: Packagist version, CI status, PHP version, license, and server/client conformance scores.
  • Replaces the 3-item PHP Libraries Using the MCP SDK list with a curated, alphabetically sorted set of downstream projects (each verified to depend on mcp/sdk, kept only if ≥50 ★ or backed by a renowned org).

Conformance score badges

  • New tests/Conformance/score.php — a Symfony Console command that turns a conformance run's --output-dir tree into a shields.io endpoint badge JSON (a scenario passes when no check has FAILURE status). Verified locally: server 29/30, client 3/26.
  • Extends the existing conformance-weekly.yaml workflow: each run now also writes results with --output-dir, scores them, and a new publish job pushes the score JSON to an orphan badges branch (self-created on first run) that the README endpoint badges read. One conformance run both gates against the baseline and produces the score — no separate workflow, no extra cron.

Notes

  • The two conformance badges render broken until conformance-weekly runs once (weekly, or via Run workflow) and creates the badges branch.
  • No behavior change to the PR conformance gate (pipeline.yaml is untouched) or to the weekly baseline gate / issue-on-failure.

🤖 Generated with Claude Code

@chr-hertel chr-hertel force-pushed the readme-badges-conformance-score branch 3 times, most recently from c651598 to 1354f66 Compare May 17, 2026 16:53
@chr-hertel chr-hertel changed the title Streamline README header and add conformance score badges Streamline README and add conformance score badges May 17, 2026
@chr-hertel chr-hertel force-pushed the readme-badges-conformance-score branch from 1354f66 to b91bd85 Compare May 17, 2026 18:47
@chr-hertel chr-hertel added the documentation Improvements or additions to documentation label May 17, 2026
@chr-hertel chr-hertel force-pushed the readme-badges-conformance-score branch from b91bd85 to aa2560b Compare May 17, 2026 19:03
- Add a shields.io badge row to the README header (version, CI, PHP
  version, license, conformance scores, protocol/spec) to match the
  other official MCP SDKs.
- Expand "PHP Libraries Using the MCP SDK" into a curated, alphabetically
  sorted list of downstream projects.
- Add tests/Conformance/bin/score.php, a Symfony Console command that
  turns a conformance run's --output-dir into a shields.io endpoint JSON.
- Extend the weekly conformance workflow to score each run and publish
  the client/server pass-rate to the orphan `badges` branch that the
  README badges read.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@chr-hertel chr-hertel force-pushed the readme-badges-conformance-score branch from aa2560b to 4305dd5 Compare May 17, 2026 19:10
@chr-hertel chr-hertel marked this pull request as ready for review May 18, 2026 10:05
@chr-hertel chr-hertel merged commit 3e45b1f into main May 18, 2026
20 checks passed
@chr-hertel chr-hertel deleted the readme-badges-conformance-score branch May 18, 2026 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants