Skip to content

README version sync: update install/config examples from v0.2.0 to v0.3.0 #181

Description

@jonathanMLDev

Problem

The README contains hardcoded version references to v0.2.0 (in npm install commands, Docker image tags, and/or MCP client configuration examples) while package.json declares v0.3.0. Users following the README instructions will install an outdated version, potentially encountering missing features, different tool schemas, or behavioral differences that don't match the current documentation.

This was flagged as High severity in the review because documentation is the primary onboarding surface for an MCP server — users configure it by copying JSON snippets from the README into their MCP client settings. A version mismatch at this stage silently puts users on the wrong version.

Acceptance Criteria

  • All version references in README.md updated to 0.3.0 (or to dynamically reference the version)
  • Search the entire doc surface (README.md, MIGRATION.md, CHANGELOG.md, any docs/ files) for stale 0.2.0 references and update all occurrences
  • Verify that npm install examples, Docker image tags, and MCP config JSON snippets all reference the correct version
  • No functional code changes — documentation only

Implementation Notes

  • Run a global search for 0.2.0 across all markdown and config files. Pay attention to CHANGELOG entries — those should retain 0.2.0 as historical records, not be updated.
  • Consider whether version references in the README should use a placeholder like <version> with a note to check package.json, or whether hardcoded versions are acceptable with the CI gate (issue Bump vitest from 3.2.4 to 4.0.18 #7) preventing future drift.

References

  • package.json: authoritative version source

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions