End-to-End Tutorial¶

This tutorial walks through the complete CapiscIO workflow: from creating an A2A agent to deploying it with trust badge enforcement.

Prerequisites¶

• Python 3.10+ or Node.js 18+
• Docker (for local server)
• capiscio CLI installed

# Install CLI via pip
pip install capiscio

# Or via npm
npm install -g capiscio

# Verify installation
capiscio --version

Part 1: Create Your Agent¶

1.1 Create Agent Card¶

Every A2A agent needs an agent-card.json that describes its capabilities:

{
  "name": "My Assistant Agent",
  "description": "A helpful assistant that can answer questions",
  "url": "https://my-agent.example.com",
  "version": "1.0.0",
  "protocolVersion": "0.3.0",
  "provider": {
    "organization": "My Company",
    "url": "https://example.com"
  },
  "capabilities": {
    "streaming": true,
    "pushNotifications": false,
    "stateTransitionHistory": false
  },
  "authentication": {
    "schemes": ["bearer"]
  },
  "defaultInputModes": ["text"],
  "defaultOutputModes": ["text"],
  "skills": [
    {
      "id": "general-qa",
      "name": "General Q&A",
      "description": "Answer general knowledge questions",
      "tags": ["qa", "knowledge"],
      "examples": [
        "What is the capital of France?",
        "Explain quantum computing"
      ]
    }
  ]
}

Save this as agent-card.json in your project root.

1.2 Validate Locally¶

Run basic schema validation:

capiscio validate ./agent-card.json

Expected output:

✅ Agent Card Valid!
   Name: My Assistant Agent
   URL: https://my-agent.example.com
   Skills: 1

1.3 Test with Strict Mode¶

For production readiness, use strict validation:

capiscio validate ./agent-card.json --strict --registry-ready

Fix any warnings before proceeding.

Part 2: Generate Keys¶

2.1 Create Ed25519 Keypair¶

Generate a signing keypair for your agent:

capiscio key gen --out-priv private.jwk --out-pub public.jwk

private.jwk
*.pem

2.2 Add Public Key to Agent Card¶

Update your agent-card.json to include the public key:

{
  "name": "My Assistant Agent",
  "...": "...",
  "publicKey": {
    "kty": "OKP",
    "crv": "Ed25519",
    "x": "YOUR_PUBLIC_KEY_X_VALUE",
    "kid": "key-1",
    "alg": "EdDSA",
    "use": "sig"
  }
}

Part 3: Register with CapiscIO Server¶

3.1 Start Local Server (Development)¶

For local development, run capiscio-server with Docker:

# Start with Docker Compose (using provided compose file)
docker-compose up -d

Server runs at http://localhost:8080.

3.2 Create an Account¶

For production, sign up at https://capiscio.io.

For local development, the server auto-creates a test account.

3.3 Create an API Key¶

# Via API (local)
curl -X POST http://localhost:8080/v1/api-keys \
  -H "Content-Type: application/json" \
  -d '{"name": "Development Key"}'

Save the returned API key securely:

export CAPISCIO_API_KEY="sk_live_xxx"

3.4 Register Your Agent¶

curl -X POST http://localhost:8080/v1/sdk/agents \
  -H "X-Capiscio-Registry-Key: $CAPISCIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Assistant Agent",
    "domain": "my-agent.example.com",
    "description": "A helpful assistant agent"
  }'

Note the returned id (UUID):

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

export AGENT_ID="550e8400-e29b-41d4-a716-446655440000"

Part 4: Get a CA-Signed Badge¶

4.1 Domain Verification (Trust Level 2)¶

For trust level 2+, add a DNS TXT record:

_capiscio.my-agent.example.com TXT "capiscio-verification=550e8400-e29b-41d4-a716-446655440000"

4.2 Request Badge¶

Use the CLI to request a badge (handles authentication automatically):

capiscio badge keep \
  --ca "http://localhost:8080" \
  --agent-id "$AGENT_ID" \
  --api-key "$CAPISCIO_API_KEY" \
  --domain "my-agent.example.com" \
  --level 2 \
  --out ./badge.jwt

Verify the badge was issued:

capiscio badge verify ./badge.jwt

Output:

✓ Badge valid
  Subject: did:web:registry.capisc.io:agents:550e8400
  Level:   2 (DV)
  Expires: 2025-01-15T10:35:00Z

4.3 Use Badge Keeper for Auto-Renewal¶

Badges expire quickly (5 minutes by default). Use the badge keeper daemon:

capiscio badge keep \
  --ca "http://localhost:8080" \
  --agent-id "$AGENT_ID" \
  --api-key "$CAPISCIO_API_KEY" \
  --domain "my-agent.example.com" \
  --out ./badge.jwt

from capiscio_sdk.badge import BadgeKeeper

keeper = BadgeKeeper(
    ca_url="http://localhost:8080",
    agent_id=os.environ["AGENT_ID"],
    api_key=os.environ["CAPISCIO_API_KEY"],
    domain="my-agent.example.com",
    output_path="./badge.jwt",
)
keeper.start()

Part 5: Deploy with Gateway¶

5.1 Start Your Agent¶

First, ensure your agent is running:

# agent.py
from fastapi import FastAPI

app = FastAPI()

@app.post("/task")
async def handle_task(request: dict):
    return {"result": "Task completed!"}

@app.get("/.well-known/agent.json")
async def agent_card():
    return {
        "name": "My Assistant Agent",
        # ... rest of agent card
    }

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=3000)

python agent.py
# Agent running at http://localhost:3000

5.2 Start the Gateway¶

The gateway validates badges before forwarding requests to your agent:

capiscio gateway start \
  --port 8080 \
  --target http://localhost:3000 \
  --registry-url http://localhost:8080

Architecture:

┌─────────────┐     ┌─────────────────┐     ┌──────────────┐
│   Client    │────▶│ CapiscIO Gateway │────▶│ Your Agent   │
│             │     │   (port 8080)    │     │ (port 3000)  │
└─────────────┘     └─────────────────┘     └──────────────┘
                           │
                           │ Validates badge
                           ▼
                    ┌─────────────────┐
                    │ capiscio-server │
                    │  /.well-known/  │
                    │    jwks.json    │
                    └─────────────────┘

5.3 Test with Badge¶

# Get your badge
BADGE=$(cat badge.jwt)

# Make request through gateway
curl -X POST http://localhost:8080/task \
  -H "Authorization: Bearer $BADGE" \
  -H "Content-Type: application/json" \
  -d '{"task": "hello"}'

5.4 Alternative: Python SDK Middleware¶

For simpler deployments, use the SDK middleware instead of the gateway:

from fastapi import FastAPI
from capiscio_sdk import SimpleGuard, SecurityConfig
from capiscio_sdk.integrations.fastapi import CapiscioMiddleware

app = FastAPI()

guard = SimpleGuard()

# Add badge verification middleware
app.add_middleware(
    CapiscioMiddleware,
    guard=guard,
    config=SecurityConfig.production(),
)

@app.post("/task")
async def handle_task(request: dict):
    return {"result": "Task completed!"}

Summary¶

You've completed the core CapiscIO workflow:

1. Create an A2A agent card
2. Validate with the CLI
3. Generate Ed25519 keys
4. Register with capiscio-server
5. Obtain CA-signed badges
6. Deploy with gateway enforcement

Next Steps¶

• Trust Scores — Monitor and improve your agent's scores
• Production Checklist — Readiness checks before going live
• Trust Model — Understand trust levels
• Badge Guides — Advanced badge operations
• Gateway Setup — Gateway configuration
• Python SDK — SDK reference