Skip to content

docs(mcp): rewrite initialize.instructions + add CHANGELOG (round-3 P1s)#25

Merged
caballeto merged 1 commit into
mainfrom
fix/devex-r3-instructions-changelog
May 6, 2026
Merged

docs(mcp): rewrite initialize.instructions + add CHANGELOG (round-3 P1s)#25
caballeto merged 1 commit into
mainfrom
fix/devex-r3-instructions-changelog

Conversation

@caballeto
Copy link
Copy Markdown
Member

Summary

Two round-3 DevEx P1 fixes for the MCP server:

  1. `initialize.instructions` — the trailing sentence said "All operations require a valid DevHelm API token", contradicting the 0.7.0 schema change that removed `api_token` from every tool's `inputSchema`. LLMs reading the instructions string would still try to thread tokens into tool args. Rewritten to point at the transport-layer auth (`Authorization: Bearer ...` for hosted, `DEVHELM_API_TOKEN` env for stdio) and explicitly note that tool schemas no longer accept tokens.

  2. `CHANGELOG.md` — written retroactively covering 0.6.0 → 0.8.2. The 0.6.0 → 0.7.0 cut renamed several required fields on tool schemas without user-visible release notes (DevEx round 3 caught this drift on a third-party client cached against 0.6.0). Going forward, every release should land with a corresponding stanza.

Test plan

  • CI green
  • Round-3 reverify: hit `/mcp/` initialize on hosted endpoint, confirm `instructions` no longer mentions "valid DevHelm API token"

Made with Cursor

The `instructions` field returned by `initialize` still said "all
operations require a valid DevHelm API token", which contradicted
the new tool schemas (api_token was removed from every tool's
inputSchema in 0.7.0). LLMs reading the instructions field would
infer they need to thread the token into tool args — the exact
behavior the schema change was meant to prevent.

Rewrite the trailing sentence to point at the transport-layer auth
(`Authorization: Bearer …` for hosted, `DEVHELM_API_TOKEN` env for
stdio) and explicitly state that tool schemas no longer accept
tokens.

Also add a CHANGELOG.md retroactively covering 0.6.0 → 0.8.2. The
0.6.0 → 0.7.0 cut renamed several required fields on tool schemas
(`api_token` removed everywhere; `delete_*.id` → `*_id`; `list_*`
no longer requires an empty `body` envelope) without any user-
visible release notes — DevEx round 3 caught this drift. Going
forward, every release should land with a corresponding stanza.

Co-authored-by: Cursor <cursoragent@cursor.com>
@caballeto caballeto merged commit 5cc1a15 into main May 6, 2026
4 checks passed
@caballeto caballeto deleted the fix/devex-r3-instructions-changelog branch May 6, 2026 17:54
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