You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* redesign README: docs-first structure, remove AXME intro, key documents prominent
* fix: rename axme-spec -> axp-spec across all references
* docs: move 6 inline diagrams from README into context-appropriate docs
README now has 1 diagram (System Context C4). Intent lifecycle moved to
D1 intents doc, container runtime to enterprise-runtime doc, trust boundary
and auth flow to security-overview, protocol envelope and idempotency to
integration-quickstart.
Implementation documentation, security model, API references, and architecture diagrams for the AXME platform.
3
+
Implementation docs, API reference, security model, and architecture diagrams for the AXME platform.
4
4
5
-
> **Alpha** - Protocol and API surface are stabilizing. Not recommended for production workloads yet.
6
-
> Install CLI, log in, run your first example in under 5 minutes. [Quick Start](https://cloud.axme.ai/alpha/cli) - [hello@axme.ai](mailto:hello@axme.ai)
It provides a model for executing **intents** - requests that may take minutes, hours, or longer to complete - across services, agents, and human participants.
21
+
---
15
22
16
-
## AXP - the Intent Protocol
23
+
## Key Documents
17
24
18
-
At the core of AXME is **AXP (Intent Protocol)** - an open protocol that defines contracts and lifecycle rules for intent processing.
25
+
| Document | Description |
26
+
|---|---|
27
+
|[`integration-quickstart.md`](docs/integration-quickstart.md)| End-to-end onboarding path for new integrators |
28
+
|[`public-api-auth.md`](docs/public-api-auth.md)| Authentication: platform API keys, actor tokens, JWT validation |
29
+
|[`security-overview.md`](docs/security-overview.md)| Security architecture, controls, and enterprise review baseline |
Without AXME Cloud runtime, these open components are still usable for protocol-compatible implementations and validation.
47
+
---
29
48
30
-
## AXME Cloud
49
+
## Platform Overview
31
50
32
-
**AXME Cloud** is the managed service that runs AXP in production together with **The Registry** (identity and routing).
51
+
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
33
52
34
-
It removes operational complexity by providing:
53
+

35
54
36
-
- reliable intent delivery and retries
37
-
- lifecycle management for long-running operations
38
-
- handling of timeouts, waits, reminders, and escalation
39
-
- observability of intent status and execution history
55
+
*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.*
40
56
41
-
State and events can be accessed through:
57
+
---
42
58
43
-
- API and SDKs
44
-
- event streams and webhooks
45
-
- the cloud console
59
+
## Related Repositories
60
+
61
+
| Repository | Role |
62
+
|---|---|
63
+
|[axp-spec](https://github.com/AxmeAI/axp-spec)| Canonical schema and protocol contracts |
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
101
-
102
-

103
-
104
-
*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.*
105
-
106
-
---
107
-
108
-
## Intent Lifecycle
109
-
110
-
Every intent progresses through a well-defined state machine. The diagram below shows all states, transitions, and terminal outcomes.
111
-
112
-

113
-
114
-
*Key states: `PENDING → PROCESSING → WAITING_* → DELIVERED → RESOLVED`. Any intent can be cancelled or expire at most transition points. Retry loops are bounded by the policy envelope.*
115
-
116
-
The complete runtime container view - services, databases, queues, and their connections:
*Gateway (public REST API), agent-core (workflow engine), auth service, MCP platform (48 JSON-RPC tools), and tool registry run as Cloud Run services sharing a PostgreSQL instance. The scheduler runs on the gateway via internal tick endpoints.*
121
-
122
-
---
123
-
124
-
## Integration Quickstart
125
-
126
-
1.**Install the CLI and run your first example**: https://cloud.axme.ai/alpha/cli
*The envelope carries the intent payload, sender identity, schema version, idempotency key, and a gateway-applied HMAC signature. Recipients verify the signature before processing.*
168
-
169
-
Idempotency and replay protection are first-class protocol features:
170
-
171
-

172
-
173
-
*Duplicate requests bearing the same idempotency key return the cached response without re-executing. Replay attacks are rejected by the nonce registry.*
174
-
175
-
---
176
-
177
-
## Security Model
178
-
179
-
The platform enforces layered security boundaries. The trust boundary diagram maps each enforcement point:
*Public-facing TLS terminates at the gateway. Internal service calls use mTLS. Data at rest is encrypted with AES-256-GCM. Webhook payloads carry HMAC-SHA256 signatures.*
184
-
185
-
Security control baseline for enterprise review: [`docs/security-overview.md`](docs/security-overview.md).
186
-
187
-
Authentication and authorization enforcement flow:
Gateway (public REST API), agent-core (workflow engine), auth service, MCP platform (48 JSON-RPC tools), and tool registry run as Cloud Run services sharing a PostgreSQL instance. The scheduler runs on the gateway via internal tick endpoints.
0 commit comments