# Documesh

> Federated developer documentation from 47 sources. Powered by WebMCP.

## When to use Documesh

Use Documesh when you need to:
- Search developer documentation across multiple sources simultaneously (Cloudflare, Netlify, Vercel, Kubernetes, React, PyTorch, Stripe, Sentry, Bun, Hono, OpenTelemetry, Argo CD, Helm, Flux, Cilium, and more)
- Match an error message or stack trace to the closest relevant documentation sections
- Look up source license and attribution information before citing documentation
- Find version-specific documentation (e.g. Kubernetes v1.32 vs v1.29)

## When NOT to use Documesh

- For source-specific advanced configuration (use the source's own docs directly)
- For non-developer documentation (general knowledge, non-technical topics)
- For vendors not in the mesh (check /vendors for the current list)

## How to integrate

Documesh exposes WebMCP tools via `document.modelContext.registerTool()`.
Any WebMCP-compatible agent can discover and call these tools when the page is open.

| Tool | When to call |
|------|-------------|
| `search_docs_across` | When the user asks about any developer documentation topic |
| `explain_error` | When the user pastes an error message or stack trace |
| `list_vendors` | When the user asks what vendors are covered or needs license info |

## API

- GET /health — Service health and snapshot date
- GET /search?q=&vendors=&limit= — Federated search (results carry actionable facts: config_keys, code_snippets, cli_commands)
- GET /explain?error=&vendor= — Error-to-docs matching (semantic rerank)
- GET /vendors — Source registry
- GET /openapi.json — OpenAPI 3.0 specification
- GET /ask?q= — NLWeb natural language query

## Actions (Act)

- POST /verify-config — Diff a config file against a source's documented keys; missing keys cited to docs
- POST /compare-configs — Cross-source config key mapping (e.g. netlify vs vercel redirects)
- GET /health-check?provider= — Provider status probe (cloudflare, github, npm, sentry)
- POST /report-issue — Report outdated/incorrect chunks (queued proposal; poll /v1/issues/{id})
- POST /submit-vendors — Submit a source for ingestion (async job; poll /v1/jobs/{id})
- GET /contribution-stats — Mesh contribution counters
- GET /payment/tiers — x402 payment tiers (free tier is the default and fully useful)

## MCP

- POST /mcp — Streamable HTTP MCP server, 9 tools: search_docs_across, explain_error, list_vendors, verify_config, compare_configs, check_service_health, report_issue, submit_source, contribution_stats
- POST /mcp/product — Product MCP server (service ops + act tools)
- POST /a2a — A2A agent endpoint (message/send, submit_task delegation)

## Developer Portal

- [Developer Resources Index](https://documesh.selatan.org/resources.html): every developer resource — API docs, OpenAPI spec, MCP server, auth docs, SDK/CLI, sandbox
- [Developer Portal](https://documesh.selatan.org/developers.html): API docs, quickstart, OpenAPI spec
- [OpenAPI Spec](https://documesh.selatan.org/openapi.json): Machine-readable API specification
- [Authentication](https://documesh.selatan.org/auth.md): Auth guide (open API, no keys needed)

## Pages

- [Versioning & Deprecation Policy](https://documesh.selatan.org/deprecation.md): API versioning strategy, Deprecation/Sunset header signaling, removal rules
- [Developer Resources](https://documesh.selatan.org/resources.html): one-page index of all API docs, OpenAPI, MCP, auth, SDK, and sandbox links
- [Home](https://documesh.selatan.org/): Overview and stats
- [App](https://documesh.selatan.org/app.html): Chat interface with WebMCP tools
- [Capabilities](https://documesh.selatan.org/capabilities.html): Tool documentation with schemas
- [WebMCP Tools](https://documesh.selatan.org/webmcp.html): Tool reference with inputSchema
- [Coverage](https://documesh.selatan.org/coverage.html): Vendors, licenses, legal exclusions
- [Submit Vendor](https://documesh.selatan.org/submit.html): Request documentation ingestion
- [About](https://documesh.selatan.org/about.html): About Documesh
- [Contact](https://documesh.selatan.org/contact.html): Contact information
- [Privacy](https://documesh.selatan.org/privacy.html): Privacy policy

## Sources

Documentation ingested from official source-published machine interfaces
(llms.txt, .md endpoints) or open-licensed git repositories. No scraping.
Full attribution on every response.

## Modular llms.txt per product area

- [API area](https://documesh.selatan.org/api/llms.txt): REST + MCP surface, versioning, errors, auth
- [Developers area](https://documesh.selatan.org/developers/llms.txt): portal, quickstart, rate limits, SDKs

## Agent Plugin

- [Agent Plugin package](https://github.com/rhps/documesh.dev): this repository is an [Agent Plugins](https://agent-plugins.org) v1.0.0 package — `plugin.json` manifest, `mcp.json` (Streamable HTTP MCP server), and 3 skills (search-docs, explain-error, list-sources).

## Source Code

- [GitHub — rhps/documesh.dev](https://github.com/rhps/documesh.dev): the complete source repository (MIT). Contains [AGENTS.md](https://github.com/rhps/documesh.dev/blob/main/AGENTS.md) with instructions for AI coding agents, and [.cursorrules](https://github.com/rhps/documesh.dev/blob/main/.cursorrules) for Cursor/Windsurf.

## License

MIT — see LICENSE in the repository.
Documentation content remains the property of respective owners.