doc updates for new structure

This commit is contained in:
John Lancaster
2026-08-30 00:16:58 -05:00
parent afedcda930
commit 88474a75f5
14 changed files with 65 additions and 68 deletions
@@ -69,4 +69,4 @@ Prompt validation is provider- and renderer-oriented. Every list or get request
1. Skills remain directly portable to tools that understand standard Agent Skills directories.
2. Native skill discovery has no parallel catalog metadata source.
3. Prompts use FastMCP's native component metadata and protocol surface without a parallel catalog or Python component file.
4. All authored content remains under `docs/`.
4. All authored content remains under `src/personal_mcp/docs/`.
+8 -8
View File
@@ -21,13 +21,13 @@ This page defines the authored content contract for the docs-first MCP architect
## Canonical Source Of Truth
1. All authored Markdown lives under `docs/`.
1. All authored Markdown lives under `src/personal_mcp/docs/`.
2. MCP resources and static docs are two distribution surfaces of the same authored files.
3. No parallel authored markdown is allowed in `src/` or other package-only paths.
3. No parallel authored Markdown is allowed in a root `docs/` directory or another source tree.
## Canonical Content Shape
Authored content is organized under `docs/`:
Authored content is organized under `src/personal_mcp/docs/`:
```mermaid
---
@@ -41,7 +41,7 @@ config:
lineColor: '#FFFFFF'
---
treeView-beta
"docs/"
"src/personal_mcp/docs/"
"*.md (top-level docs pages)"
"contracts/"
"prompt.md"
@@ -59,9 +59,9 @@ treeView-beta
## File Placement And Ownership Boundaries
1. Top-level project docs stay in `docs/*.md`.
2. Skill docs stay in `docs/skills/<skill-id>/...`.
3. Prompt docs stay in `docs/prompts/<prompt-id>/...`.
1. Top-level project docs stay in `src/personal_mcp/docs/*.md`.
2. Skill docs stay in `src/personal_mcp/docs/skills/<skill-id>/...`.
3. Prompt docs stay in `src/personal_mcp/docs/prompts/<prompt-id>/...`.
4. A skill or prompt may link across sections, but must not store content in another artifact's directory.
5. Server and runtime code may index and serve docs, but must not be the source of authored markdown.
@@ -74,7 +74,7 @@ treeView-beta
This contract guarantees:
1. One authored source tree in `docs/` for both website and MCP.
1. One authored source tree in `src/personal_mcp/docs/` for both website and MCP.
2. Skill and prompt artifacts remain path-stable within their own sections.
3. Cross-surface publishing remains deterministic because authored content paths are canonical.
+2 -2
View File
@@ -22,7 +22,7 @@ config:
lineColor: '#FFFFFF'
---
treeView-beta
"docs/prompts/"
"src/personal_mcp/docs/prompts/"
"<prompt-id>/"
"PROMPT.md"
"src/personal_mcp/prompts/"
@@ -45,7 +45,7 @@ Rules:
1. Each `PROMPT.md` owns both its runtime metadata and prose.
2. Python owns only generic parsing, validation, rendering, and provider behavior.
3. There is no central prompt catalog, generated signature, or metadata sidecar.
4. The provider scans direct children of packaged `docs/prompts/` on each list or get request.
4. The provider scans direct children of packaged `personal_mcp/docs/prompts/` on each list or get request.
5. Additions, edits, and deletions become visible on the next request without restarting the server.
6. Reload is pull-based; the provider does not watch files or emit proactive change notifications.
@@ -8,7 +8,7 @@ This page defines the canonical contract for skills in the docs-first MCP archit
## Canonical Skill Shape
Each skill is one directory under `docs/skills/`:
Each skill is one directory under `src/personal_mcp/docs/skills/`:
```mermaid
---
@@ -22,7 +22,7 @@ config:
lineColor: '#FFFFFF'
---
treeView-beta
"docs/"
"src/personal_mcp/docs/"
"... (other docs)"
"skills/"
"<skill-id>/"
@@ -70,7 +70,7 @@ Invalid examples:
## Provider Publication
[`SkillsDirectoryProvider`](https://gofastmcp.com/servers/providers/skills) scans `docs/skills/` with `supporting_files="template"` and publishes:
[`SkillsDirectoryProvider`](https://gofastmcp.com/servers/providers/skills) scans packaged `personal_mcp/docs/skills/` with `supporting_files="template"` and publishes:
1. `skill://<skill-id>/SKILL.md`
2. `skill://<skill-id>/_manifest`
+1 -1
View File
@@ -46,7 +46,7 @@ FastMCP confines reads to the selected skill directory. Absolute paths, traversa
## General Docs URI
General authored documentation is exposed through `resource://docs/{path*}`. The wildcard accepts normalized relative POSIX Markdown paths beneath `docs/`, excludes the provider-owned `skills/` subtree, and rejects absolute paths, traversal segments, backslashes, and non-Markdown targets.
General authored documentation is exposed through `resource://docs/{path*}`. The wildcard accepts normalized relative POSIX Markdown paths beneath packaged `personal_mcp/docs/`, excludes the provider-owned `skills/` subtree, and rejects absolute paths, traversal segments, backslashes, and non-Markdown targets.
Prompts are MCP prompt components rather than resources. Clients discover them with the protocol `prompts/list` operation and render them with `prompts/get`.