Skip to content

docs: post-release drift — MCP setup points at target/ jars, deploy.md says MCP is not built #133

Description

@josepharuja

Two concrete inaccuracies found reading the docs as an outsider after v0.2.0.

1. Every documented MCP path requires a local Maven build

docs/demo/claude-desktop.md hardcodes /ABSOLUTE/PATH/TO/cistern-mcp/target/cistern-mcp-0.1.0-SNAPSHOT-bridge.jar and runs java -jar cistern-app/target/cistern-app-*.jar. docs/INTEGRATION.md does the same.

But cistern-mcp-0.2.0-bridge.jar is a published Release asset (verified: the v0.2.0 release carries app jar, CLI jar, bridge jar, the cistern wrapper and SHA256SUMS). No document tells a reader to download it. A stranger following the MCP docs must clone and mvn first — which the v0.1.0 release gate was specifically meant to eliminate.

Also stale: the version in those paths is 0.1.0-SNAPSHOT.

2. deploy.md says the MCP front door does not exist

docs/deploy.md lists under "What is still not there" → "MCP front door (Phase 6)". MCP shipped in 0.2.0 (T6.1/T6.2). deploy.md was not updated for the release it postdates.

DoD

  • MCP setup docs use the published bridge jar and a documented download step; local-build instructions remain as an explicit alternative, not the default.
  • Versions in doc paths are current, or use a <version> placeholder with one place to change.
  • docs/deploy.md reflects what 0.2.0 actually ships.
  • A release-time check (or RELEASE.md step) that greps docs for target/ paths and stale version pins, so this does not recur.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions