Skip to content

Commit 248ec26

Browse files
Add {AGENTS,CLAUDE}.md with documentation structure overview
Documents the non-obvious patterns in this repo: Mintlify vs Hugo systems, date-based specification versioning, and schema generation workflow. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 6924a8c commit 248ec26

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

AGENTS.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Model Context Protocol (MCP)
2+
3+
This repository contains the MCP specification, documentation, and blog.
4+
5+
## Documentation Structure
6+
7+
- `docs/` - Mintlify site (`npm run serve:docs`)
8+
- `docs/docs/` - guides and tutorials
9+
- `docs/specification/` - MCP specification (more formal, versioned)
10+
- `blog/` - Hugo blog (`npm run serve:blog`)
11+
12+
## Specification Versioning
13+
14+
Specifications use **date-based versioning** (YYYY-MM-DD), not semantic versioning:
15+
16+
- `schema/[YYYY-MM-DD]/` and `docs/specification/[YYYY-MM-DD]/` - released versions
17+
- `schema/draft/` and `docs/specification/draft/` - in-progress work
18+
19+
## Schema Generation
20+
21+
TypeScript files are the **source of truth** for the protocol schema:
22+
23+
- Edit: `schema/[version]/schema.ts`
24+
- Generate JSON + docs: `npm run generate:schema`
25+
- This creates both `schema/[version]/schema.json` and the Schema Reference document in `docs/specification/[version]/schema.mdx`
26+
27+
Always regenerate after editing schema files.
28+
29+
## Useful Commands
30+
31+
```bash
32+
npm run serve:docs # Local Mintlify docs server
33+
npm run serve:blog # Local Hugo blog server
34+
npm run generate:schema # Generate JSON schemas + MDX from TypeScript
35+
npm run check:docs # Check formatting and links
36+
npm run check # Run all checks
37+
```

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)