Skip to content

Quickstarts

Choose your path to get started with CapiscIO. Each quickstart takes about 5 minutes and gets you to a working result.

Choose Your Goal

Quickstart Description Time Difficulty
Validate Your First Agent Check if an AI agent is A2A compliant ~5 min Easy
Secure a FastAPI Agent Add authentication to your A2A agent ~10 min Medium
CI/CD with GitHub Actions Automate validation in your workflows ~5 min Easy

What You'll Learn

  • Validation Quickstart

    • Install the CapiscIO CLI
    • Validate a local agent-card.json
    • Understand validation reports
    • Check compliance scores

    Start Validating

  • Security Quickstart

    • Add SimpleGuard to your agent
    • Generate cryptographic keys
    • Sign outbound requests
    • Verify inbound requests

    Start Securing

  • CI/CD Quickstart

    • Add the GitHub Action
    • Configure validation thresholds
    • Add PR comments
    • Block non-compliant deployments

    Start Automating

Prerequisites

Before starting any quickstart, make sure you have:

  • Node.js 18+ or Python 3.10+ installed
  • A terminal/command line
  • An agent-card.json file (we'll provide a sample)
  • Python 3.10+ installed
  • A FastAPI or similar web application
  • Basic understanding of async Python
  • A GitHub repository
  • Basic understanding of GitHub Actions

Sample Agent Card

Don't have an agent-card.json yet? Use this sample to follow along:

agent-card.json
{
  "name": "My First Agent",
  "description": "A sample A2A agent for testing",
  "url": "https://example.com/agent",
  "version": "1.0.0",
  "protocolVersion": "0.2.0",
  "provider": {
    "organization": "My Company"
  },
  "capabilities": {
    "streaming": false,
    "pushNotifications": false
  },
  "skills": [
    {
      "id": "greeting",
      "name": "Greeting",
      "description": "Returns a friendly greeting"
    }
  ]
}

Save this as agent-card.json in your working directory to use in the quickstarts.

Next Steps After Quickstarts

Once you've completed a quickstart, explore:

  • Concepts — Deep dive into how CapiscIO works
  • Recipes — Practical solutions for specific problems
  • Troubleshooting — Solutions to common problems