docs: add SEP scenario review guidance to AGENTS.md (#247)
This commit is contained in:
parent
22b4dce608
commit
88c087e9c4
1 changed files with 11 additions and 0 deletions
11
AGENTS.md
11
AGENTS.md
|
|
@ -53,6 +53,7 @@ Keep scenarios separate when they're genuinely independent features or when they
|
|||
- **Optimize for Ctrl+F on the slug.** Repetitive check blocks are fine — easier to find the failing one than to unwind a clever helper.
|
||||
- Reuse `ConformanceCheck` and other types from `src/types.ts` rather than defining parallel shapes.
|
||||
- Include `specReferences` pointing to the relevant spec section.
|
||||
- **Severity follows the spec keyword:** MUST / MUST NOT → `FAILURE`; SHOULD / SHOULD NOT → `WARNING`. (CI treats WARNING as a failure, so Tier-1 SDKs still need to satisfy SHOULDs — see #245.)
|
||||
|
||||
## Descriptions and wording
|
||||
|
||||
|
|
@ -60,6 +61,16 @@ Be precise about what's **required** vs **optional**. A scenario description tha
|
|||
|
||||
When in doubt about spec details (OAuth parameters, audiences, grant types), check the actual spec in `modelcontextprotocol` rather than guessing.
|
||||
|
||||
## Reviewing PRs
|
||||
|
||||
### SEP scenarios
|
||||
|
||||
Verify requirement levels against the SEP's **spec diff** — the change to `docs/specification/draft/` in the SEP's PR — not the SEP markdown summary or the conformance PR's description. The keyword that governs check severity is the one in the spec text; a bullet under a "Servers SHOULD…" sentence is SHOULD-level even if the SEP's title says "standardize."
|
||||
|
||||
```sh
|
||||
gh api "repos/modelcontextprotocol/modelcontextprotocol/contents/docs/specification/draft/<path>?ref=<sep-branch>" --jq '.content' | base64 -d
|
||||
```
|
||||
|
||||
## Examples: prove it passes and fails
|
||||
|
||||
A new scenario should come with:
|
||||
|
|
|
|||
Loading…
Reference in a new issue