Repository navigation
docs: document the official-SDK API and 0.3.0 upgrade notes #91
Description
Part of #44.
Do
- README:
- Prerequisites: Go 1.25+, protoc version, plugin versions. Replace the stale "Go 1.20+" and "protoc-gen-go-grpc 1.71".
- What the plugin generates: a short snippet wiring a generated server with the official SDK, both over stdio (
server.Run(ctx, &mcp.StdioTransport{})) and Streamable HTTP (mcp.NewStreamableHTTPHandler). - How tool arguments map to the request message: protojson field names, 64-bit integers as strings, enums by name.
- Upgrading from 0.2.x: what changed (official SDK types, the input schema shape, argument validation) and what callers must change.
- CONTRIBUTING: how to run the tests, update the golden file (
-update), and regenerate the examples.
Acceptance criteria
- The README snippets compile: put them in an
example_test.goorexamples/program thatgo vetandgo buildcover, and keep the README in sync with it. - No mention of mark3labs remains in the docs (except the upgrade notes).
Activity
erikist commentedon Oct 8, 2026
🤖 Factory: picked up by dispatcher; working on branch factory/91-docs-document-the-official-sdk-api.
erikist commentedon Oct 8, 2026
🤖 Factory: opened PR #102 (#102), documenting the official-SDK API (prerequisites, wiring snippets for stdio/Streamable HTTP, protojson argument mapping, upgrade notes from 0.2.x) and the CONTRIBUTING workflow (checks, golden-file
-update,make generate). README snippets are backed by a new compile-checkedexamples/gen/example/v1/example_test.go.gofmt,go vet,go build, andgo testall pass; nomark3labsmentions remain outside the upgrade notes.docs: address review feedback on SDK docs (#91)
docs: document the official-SDK API and 0.3.0 upgrade notes (#91) (#102)