Docs MCP Server
Read CharmIQ's own documentation as Markdown — the simplest server and the best way to test your OAuth flow.
|
|
list_docs and read_doc end-to-end, your OAuth flow works.https://api.charmiq.ai/mcp/docsTools
list_docs | |
read_doc |
Typical Workflow
list_docs()— catalog of every documentation page.Pick a slug, call read_doc(slug)— Markdown content.
Why Build Against It
Smoke testing. First call you make after wiring up OAuth. It's read-only, it costs nothing, it works on every account — if list_docsandread_doccome back clean, the rest of the surface works the same way.In-app reference. A Charm that needs to answer questions about CharmIQ itself benefits from having the docs as context. Indexed assistance. An external assistant that pulls the docs into its own index updates from this endpoint.
https://team.charmiq.ai/docs. Use the MCP surface when a machine is reading; use the web when a person is.Patterns
Cache aggressively. Docs change rarely. Pull the catalog once per session and re-use. Treat slugs as stable. They're the URL-friendly identifier and they don't move under you.