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
- Consolidate duplicate Alpha banner into single blockquote
- Add one-liner description after title
- Wrap repository structure tree in collapsible details tag
- Collapse Visualization Program section into details tag
- Move local validation commands to Contributing section
- Replace em dashes with regular dashes throughout
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+41-31Lines changed: 41 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
# axme-docs
2
2
3
-
**Public documentation for the AXME platform** — API references, protocol specifications, integration guides, security model, and the full visualization program.
3
+
Implementation documentation, security model, API references, and architecture diagrams for the AXME platform.
4
4
5
-
> **Alpha**· Protocol and API surface are stabilizing. Not recommended for production workloads yet.
6
-
> **Alpha** — 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)
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)
7
7
8
8
---
9
9
10
10
## What Is AXME?
11
11
12
12
AXME is a coordination infrastructure for durable execution of long-running intents across distributed systems.
13
13
14
-
It provides a model for executing **intents**— requests that may take minutes, hours, or longer to complete — across services, agents, and human participants.
14
+
It provides a model for executing **intents**- requests that may take minutes, hours, or longer to complete - across services, agents, and human participants.
15
15
16
-
## AXP — the Intent Protocol
16
+
## AXP - the Intent Protocol
17
17
18
-
At the core of AXME is **AXP (Intent Protocol)**— an open protocol that defines contracts and lifecycle rules for intent processing.
18
+
At the core of AXME is **AXP (Intent Protocol)**- an open protocol that defines contracts and lifecycle rules for intent processing.
19
19
20
20
AXP can be implemented independently.
21
21
The open part of the platform includes:
@@ -46,7 +46,8 @@ State and events can be accessed through:
46
46
47
47
---
48
48
49
-
## Repository Structure
49
+
<details>
50
+
<summary>Full repository structure</summary>
50
51
51
52
```
52
53
axme-docs/
@@ -71,7 +72,7 @@ axme-docs/
71
72
│ ├── examples-cloud-vs-protocol.md
72
73
│ ├── external-integrator-dry-run.md
73
74
│ ├── integration-quickstart.md
74
-
│ ├── mcp-api-reference.md # MCP API reference — all 48 tools, auth, response format
75
+
│ ├── mcp-api-reference.md # MCP API reference - all 48 tools, auth, response format
The diagram below shows how AXME components relate: the public gateway, control plane services, connectors, and client SDKs.
98
101
99
-

102
+

100
103
101
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.*
102
105
@@ -110,9 +113,9 @@ Every intent progresses through a well-defined state machine. The diagram below
110
113
111
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.*
112
115
113
-
The complete runtime container view — services, databases, queues, and their connections:
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.*
118
121
@@ -127,13 +130,6 @@ The complete runtime container view — services, databases, queues, and their c
*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.*
188
184
@@ -196,13 +192,16 @@ Authentication and authorization enforcement flow:
196
192
197
193
---
198
194
199
-
## Visualization Program
195
+
<details>
196
+
<summary>Visualization program</summary>
200
197
201
198
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).
0 commit comments