Skip to content

docs: add conformance summary to README#893

Open
matteoroxis wants to merge 1 commit intomodelcontextprotocol:mainfrom
matteoroxis:docs/add-conformance-score-readme
Open

docs: add conformance summary to README#893
matteoroxis wants to merge 1 commit intomodelcontextprotocol:mainfrom
matteoroxis:docs/add-conformance-score-readme

Conversation

@matteoroxis
Copy link
Copy Markdown

Add a conformance summary section to the root README and link to the detailed validation results.

Motivation and Context

This change addresses issue #798, which requests adding the conformance test results to the README.

The goal is to make the current MCP Java SDK conformance status easier to discover directly from the repository homepage, while keeping the full details in conformance-tests/VALIDATION_RESULTS.md.

How Has This Been Tested?

This is a documentation-only change.

The values added to the README were taken from the existing conformance-tests/VALIDATION_RESULTS.md file and summarized there without changing any code or test behavior.

Breaking Changes

No breaking changes.

This update only affects documentation and does not require users to change code or configuration.

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

This PR adds a short conformance summary for:

  • Server conformance
  • Client conformance
  • Auth conformance

and links readers to conformance-tests/VALIDATION_RESULTS.md for the full validation report.

@Kehrlann
Copy link
Copy Markdown
Contributor

Kehrlann commented Apr 1, 2026

Thanks for the PR! Small suggestion, + we now have 13/14 scenarios passing in auth, after #895 is merged.

Maybe we should mention that we run against conformane 0.1.15. What do you think?

@Kehrlann Kehrlann self-requested a review April 1, 2026 15:01
@Kehrlann Kehrlann self-assigned this Apr 1, 2026
@Kehrlann Kehrlann added the documentation Improvements or additions to documentation label Apr 1, 2026
# Client conformance
./mvnw clean package -DskipTests -pl conformance-tests/client-jdk-http-client -am
npx @modelcontextprotocol/conformance client \
--command "java -jar conformance-tests/client-jdk-http-client/target/client-jdk-http-client-1.1.0-SNAPSHOT.jar" \
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
--command "java -jar conformance-tests/client-jdk-http-client/target/client-jdk-http-client-1.1.0-SNAPSHOT.jar" \
--command "java -jar conformance-tests/client-jdk-http-client/target/client-jdk-http-client-2.0.0-SNAPSHOT.jar" \

@Kehrlann Kehrlann added the waiting for user Waiting for user feedback or more details label Apr 1, 2026
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 waiting for user Waiting for user feedback or more details

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants