Add MCP Apps Overview document
Adds `docs/overview.md` covering the core concepts: architecture, lifecycle, UI resources, bidirectional communication, theming, display modes, and security. Includes mermaid flowchart and sequence diagrams. Also adds the `@boneskull/typedoc-plugin-mermaid` TypeDoc plugin for mermaid diagram support. However, the plugin handles HTML entities from TypeDoc incorrectly, so `scripts/typedoc-plugin-fix-mermaid-entities.mjs` decodes HTML entities before the plugin processes them. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
2109dccadb
commit
d856b8bda6
1 changed files with 296 additions and 1 deletions
|
|
@ -8,6 +8,7 @@ const config = {
|
|||
},
|
||||
gitRevision: "main",
|
||||
projectDocuments: [
|
||||
"docs/overview.md",
|
||||
"docs/quickstart.md",
|
||||
"docs/patterns.md",
|
||||
"docs/migrate_from_openai_apps.md",
|
||||
|
|
@ -38,7 +39,12 @@ const config = {
|
|||
"https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/draft/apps.mdx",
|
||||
},
|
||||
out: "docs/api",
|
||||
plugin: ["typedoc-github-theme"],
|
||||
plugin: [
|
||||
"typedoc-github-theme",
|
||||
"./scripts/typedoc-plugin-fix-mermaid-entities.mjs",
|
||||
"@boneskull/typedoc-plugin-mermaid",
|
||||
],
|
||||
ignoredHighlightLanguages: ["mermaid"],
|
||||
};
|
||||
|
||||
export default config;
|
||||
|
|
|
|||
Loading…
Reference in a new issue