Build with AI
Give coding assistants a stable, read-only view of Tyxter docs, public OpenAPI schema, and launch-critical integration guidance.
Use local URLs while developing against the Docker stack, and production URLs when an agent is generating integration code for a hosted app.
Generate integrations only from Tyxter discovery surfaces:
/.well-known/tyxter.json, /.well-known/api-catalog, /openapi.json, /llms.txt, and /mcp. Public API calls use the advertised /v1/* routes.In customer apps and scripts, name the API origin variable
TYXTER_API_BASE_URL. For production, set it to https://api.tyxter.com; avoid generic site-base variables for API calls.Discovery
Agents can start from the dashboard origin and still find the canonical docs artifacts. The dashboard host passes through the top-level docs files and exposes the API-owned well-known manifest.
Discovery: https://tyxter.com/.well-known/tyxter.json
API catalog: https://tyxter.com/.well-known/api-catalog
Production API base: https://api.tyxter.com
OpenAPI: https://docs.tyxter.com/docs/openapi.json
LLM index: https://docs.tyxter.com/docs/llms.txt
MCP: https://docs.tyxter.com/docs/mcpArtifacts
llms.txt
Concise Markdown index grouped by docs section.
llms-full.txt
Launch-critical docs concatenated into one Markdown bundle.
OpenAPI JSON
Generated OpenAPI 3.1 schema for public API endpoints only.
MCP & Docs
Read-only Streamable HTTP endpoint for MCP-capable clients.
Cursor
Reference the concise docs index or the full bundle in project rules.
Tyxter docs: https://docs.tyxter.com/docs/llms.txt
Full Tyxter docs: https://docs.tyxter.com/docs/llms-full.txt
OpenAPI: https://docs.tyxter.com/docs/openapi.jsonClaude Code
Add the MCP endpoint for searchable docs and OpenAPI retrieval.
{
"mcpServers": {
"tyxter-docs": {
"type": "http",
"url": "https://docs.tyxter.com/docs/mcp"
}
}
}Codex
Point Codex at the same docs origin that serves this page.
Docs: https://docs.tyxter.com/docs/llms.txt
Full docs: https://docs.tyxter.com/docs/llms-full.txt
OpenAPI: https://docs.tyxter.com/docs/openapi.json
MCP: https://docs.tyxter.com/docs/mcpGeneric MCP clients
{
"servers": {
"tyxter-docs": {
"type": "http",
"url": "https://docs.tyxter.com/docs/mcp"
}
}
}When to use each resource
- Use
/llms.txtwhen the agent needs a lightweight index and can follow links. - Use
/llms-full.txtwhen the agent needs offline context for launch-critical docs. - Use
/openapi.jsonwhen generating typed clients, request validators, or endpoint tests. - Use
/mcpwhen the client supports tool calls and resource reads.