Skip to content

Commit f09b816

Browse files
docs(REVIEW.md): address review feedback
- Add docs-consistency and examples checks to Checklist - Add Reference section with spec MCP server and llms-full.txt - ProtocolError/ProtocolErrorCode (was McpError) - z.looseObject() (was .passthrough())
1 parent e8d167a commit f09b816

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

REVIEW.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,17 @@ review rounds and grows over time.
5151
**Tests & docs**
5252
- New behavior has vitest coverage including error paths
5353
- Breaking changes documented in `docs/migration.md` and `docs/migration-SKILL.md`
54+
- Bugfix or behavior change: check whether `docs/**/*.md` describes the old behavior and needs updating; flag prose that now contradicts the implementation
55+
- New feature: verify prose documentation is added (not just JSDoc), and assess whether `examples/` needs a new or updated example
56+
- Behavior change: assess whether existing `examples/` still compile and demonstrate the current API
57+
58+
## Reference
59+
60+
When verifying spec compliance, consult the spec directly rather than relying on memory:
61+
62+
- MCP documentation server: `https://modelcontextprotocol.io/mcp`
63+
- Full spec text (single file, LLM-friendly): `https://modelcontextprotocol.io/llms-full.txt` — fetch to a temp file and grep for the relevant section
64+
- Schema source of truth: [`schema.ts`](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/schema/draft/schema.ts)
5465

5566
## Recurring Catches
5667

0 commit comments

Comments
 (0)