admp/docs-generator.json at main · agentdispatch/admp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
  "project": "Agent Dispatch (ADMP)",
  "description": "Universal inbox for autonomous AI agents — standardized messaging infrastructure with at-least-once delivery, Ed25519 authentication, and DID federation",
  "baseUrl": "https://agentdispatch.fly.dev",
  "_baseUrl_note": "Update baseUrl here and regenerate docs if the production URL changes",
  "sources": [
    { "path": "src/server.js", "extractor": "rest-api", "provides": "Express app setup, global auth middleware, route mounting" },
    { "path": "src/routes/agents.js", "extractor": "rest-api", "provides": "Agent registration, heartbeat, trust, webhook, key rotation, identity, tenant, approval endpoints" },
    { "path": "src/routes/inbox.js", "extractor": "rest-api", "provides": "Message send, pull, ack, nack, reply, status, inbox stats endpoints" },
    { "path": "src/routes/groups.js", "extractor": "rest-api", "provides": "Group creation, membership, messaging, join/leave endpoints" },
    { "path": "src/routes/outbox.js", "extractor": "rest-api", "provides": "Outbound email via Mailgun — domain config, send, message queries, webhooks" },
    { "path": "src/routes/discovery.js", "extractor": "rest-api", "provides": "Public key directory (.well-known/agent-keys.json) and DID document endpoints" },
    { "path": "src/middleware/auth.js", "extractor": "generic", "provides": "Authentication model: HTTP Signatures, API keys, DID:web federation, enrollment tokens" },
    { "path": "src/services/agent.service.js", "extractor": "generic", "provides": "Agent lifecycle: registration modes, approval workflow, key rotation" },
    { "path": "openapi.yaml", "extractor": "openapi", "provides": "OpenAPI 3.1 spec for supplementary endpoint documentation" },
    { "path": "Dockerfile", "extractor": "architecture", "provides": "Container build and runtime config" },
    { "path": "fly.toml", "extractor": "architecture", "provides": "Fly.io deployment topology and env vars" },
    { "path": "docker-compose.yml", "extractor": "architecture", "provides": "Local multi-service dev topology" },
    { "path": "package.json", "extractor": "architecture", "provides": "Dependencies, scripts, and metadata" },
    { "path": "whitepaper/v1.md", "extractor": "generic", "provides": "ADMP v1.0 specification (protocol semantics, message format, security model)" },
    { "path": "cli/src/index.ts", "extractor": "cli-commands", "provides": "CLI command registration — 16 commands via commander.js" },
    { "path": "cli/src/auth.ts", "extractor": "typescript-api", "provides": "Auth library exports: buildAuthHeaders, signEnvelope, Ed25519 signing primitives" },
    { "path": "cli/src/client.ts", "extractor": "typescript-api", "provides": "HTTP client library: AdmpClient class with signature/api-key/none auth modes" },
    { "path": "cli/src/config.ts", "extractor": "typescript-api", "provides": "Config management: ~/.admp/config.json, env var overrides, requireConfig" },
    { "path": "cli/package.json", "extractor": "config", "provides": "CLI package metadata, subpath exports, dependencies" }
  ],
  "outputs": [
    {
      "type": "llms-txt",
      "path": "llms.txt",
      "maxLines": 250,
      "audience": "AI agents integrating with ADMP"
    },
    {
      "type": "agent-guide",
      "path": "docs/AGENT-GUIDE.md",
      "audience": "AI agents using the API directly"
    },
    {
      "type": "architecture",
      "path": "docs/ARCHITECTURE.md",
      "diagrams": ["component", "data-flow", "deployment"],
      "includeEnvVars": true,
      "includeSecuritySection": true
    },
    {
      "type": "error-codes",
      "path": "docs/ERROR-CODES.md",
      "audience": "Developers and AI agents handling errors"
    },
    {
      "type": "api-reference",
      "path": "docs/API-REFERENCE.md",
      "audience": "Developers integrating with the ADMP HTTP API"
    },
    {
      "type": "cli-reference",
      "path": "docs/CLI-REFERENCE.md",
      "audience": "Developers and agents using the ADMP CLI and library"
    }
  ],
  "validate": [],
  "deploy": null,
  "regenerate": "To regenerate docs, run: /docs-generator (in Claude Code) or invoke the docs-generator skill with this config.",
  "rules": {
    "sourceIsTruth": true,
    "preserveExamples": true,
    "addTimestamp": true
  }
}