axme-docs
April 11, 2026 · View on GitHub
Implementation docs, API reference, security model, and architecture diagrams for the AXME platform.
Quick Start · axme · Spec · Examples
Integration Quickstart
- Install the CLI and run your first example: https://cloud.axme.ai/alpha/cli
- Choose your SDK: Python · TypeScript · Go · Java · .NET
- Follow
docs/integration-quickstart.mdfor the full onboarding path - Example hubs:
- Cloud runnable: axme-examples/examples
- Protocol-only: axme-examples/protocol
Key Documents
| Document | Description |
|---|---|
integration-quickstart.md | End-to-end onboarding path for new integrators |
public-api-auth.md | Authentication: platform API keys, actor tokens, JWT validation |
security-overview.md | Security architecture, controls, and enterprise review baseline |
supported-limits-and-error-model.md | Rate limits, quotas, error codes, retriability table |
migration-and-deprecation-policy.md | API versioning, deprecation timelines, migration guides |
mcp-api-reference.md | MCP Server - all 48 tools, auth model, response format |
cross-org-receive-policy.md | Cross-org intent delivery: org policy + agent overrides |
agent-addressing.md | Agent address registry, agent:// URI scheme |
API Family References
| Document | Scope |
|---|---|
D1 - Intents, Inbox, Approvals | Intent CRUD, SSE, lifecycle events, human tasks |
D2 - Webhooks, Capabilities | Webhook subscriptions, deliveries, event types |
D3 - Users | User profiles, nicks, contacts |
D4 - Invites, Media | Invite links, media upload/download |
D5 - Schemas | Schema governance, payload validation |
D6 - Enterprise Governance | Orgs, workspaces, members, agents, policies, quotas |
Platform Overview
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
The gateway is the single public entry point. Intents flow from SDK clients through TLS to the gateway, which routes them into the durable scheduler and connector layer. Webhooks and MCP callbacks leave the platform from the connector side, cryptographically signed.
Related Repositories
| Repository | Role |
|---|---|
| axp-spec | Canonical schema and protocol contracts |
| Control-plane runtime (private) | Internal runtime implementation |
| axme-conformance | Conformance and contract test suite |
| axme-sdk-python | Python SDK |
| axme-sdk-typescript | TypeScript SDK |
| axme-sdk-go | Go SDK |
| axme-sdk-java | Java SDK |
| axme-sdk-dotnet | .NET SDK |
| axme-cli | Command-line interface |
Full repository structure
axme-docs/
├── docs/
│ ├── diagrams/ # Full visualization program (SVG / PNG / DOT / MMD sources)
│ │ ├── intents/ # Intent lifecycle, policy, delivery, approvals
│ │ ├── platform/ # System context, container view, enterprise placement
│ │ ├── protocol/ # Protocol envelope, versioning, idempotency, transport
│ │ ├── api/ # API method families, error model, pagination, quotas
│ │ ├── security/ # Auth/authz, crypto, trust boundaries, threat model
│ │ ├── operations/ # Release, DR, SLOs, observability, runbooks
│ │ └── website/ # Diagrams for the public website / landing page
│ ├── openapi/ # OpenAPI artifacts for the public API surface
│ ├── connectors/ # Connector setup guides (HTTP, webhook, MCP)
│ ├── ADR-002-service-boundaries.md
│ ├── ADR-003-trust-consent-model.md
│ ├── axme-is-not-rpc.md
│ ├── B2B_FEATURES.md
│ ├── enterprise-routing-transport-operations.md
│ ├── enterprise-runtime-model-and-placement.md
│ ├── enterprise-scoped-credentials-migration-note.md
│ ├── examples-cloud-vs-protocol.md
│ ├── external-integrator-dry-run.md
│ ├── integration-quickstart.md
│ ├── mcp-api-reference.md # MCP API reference - all 48 tools, auth, response format
│ ├── mcp-axme-continuation-pattern.md
│ ├── migration-and-deprecation-policy.md
│ ├── migration-message-centric-to-intent-lifecycle.md
│ ├── MVP_SCOPE.md
│ ├── public-api-auth.md
│ ├── public-api-families-d1-intents-inbox-approvals.md
│ ├── public-api-families-d2-webhooks-capabilities.md
│ ├── public-api-families-d3-users.md
│ ├── public-api-families-d4-invites-media.md
│ ├── public-api-families-d5-schemas.md
│ ├── public-api-families-d6-enterprise-governance.md
│ ├── security-overview.md
│ └── supported-limits-and-error-model.md
├── scripts/
│ └── validate_docs.py
└── tests/
Visualization program
The docs/diagrams/ directory is the canonical home for all platform visualizations. Each diagram is available in four formats: .mmd (Mermaid source), .dot (Graphviz source), .svg (rendered vector), and .png (raster).
- Visualization Backlog & Status - P0 / P1 / P2 diagram inventory
- Diagram Usage Matrix - which diagrams appear in which repositories
- Repository Distribution Plan - placement strategy
Contributing
Bug reports and docs feedback: open an issue in this repository.
Validate locally
python -m pip install -e ".[dev]"
python scripts/validate_docs.py
pytest