Getting Help¶

Need help with CapiscIO? Here are the best ways to get support.

Documentation¶

Start with the documentation for your specific product:

A2A Security Documentation - Security middleware guides and API reference
CapiscIO CLI Documentation - Command-line tools and validation

Quick Links¶

Getting Started¶

Common Tasks¶

For A2A Security:

For CapiscIO CLI:

GitHub Resources¶

Issues & Bug Reports¶

Report bugs or request features in the relevant repository:

When reporting issues, please include:

Product version
Operating system
Clear steps to reproduce
Expected vs actual behavior
Relevant error messages or logs

Pull Requests¶

Want to contribute? See our Contributing Guide for details on:

Setting up your development environment
Making changes locally
Testing your contributions
Submitting pull requests

Package Resources¶

Python (A2A Security)¶

PyPI: a2a-security package
Installation: pip install a2a-security
Requirements: Python 3.10+

Node.js (CapiscIO CLI)¶

npm: capiscio-cli package
Installation: npm install -g capiscio-cli
Requirements: Node.js 18+

A2A Protocol¶

CapiscIO implements the Agent-to-Agent (A2A) Protocol. Learn more:

A2A Specification - Official protocol specification
A2A Inspector - Interactive protocol explorer
Online Validator - Web-based agent card validator

Community¶

Contributing¶

We welcome contributions! Check out:

Stay Updated¶

GitHub: Watch the repositories for updates
capiscio/a2a-security
capiscio/capiscio-cli
Releases: Check Releases for changelogs

Security Issues¶

Found a security vulnerability? Please report it responsibly:

Do not open a public issue
See Security Policy for reporting process
Security issues are handled with priority

Frequently Asked Questions¶

Common Questions

Can't find what you're looking for? Check these frequently asked questions or open an issue on GitHub.

Installation Issues¶

Q: pip install capiscio-a2a-security fails

A: Ensure you have Python 3.10 or higher:

python --version
pip install --upgrade pip
pip install a2a-security

Q: CLI command not found after installation

A: Make sure npm global bin directory is in your PATH:

npm config get prefix
# Add <prefix>/bin to your PATH

Usage Questions¶

Q: How do I validate agent cards?

A: Use capiscio-cli:

capiscio validate path/to/agent-card.json

Or programmatically with Python:

from a2a_security import validate_message

result = validate_message(message_data)

Q: Where can I find example agent cards?

A: Check the CLI repository examples

Development Questions¶

Q: How do I run tests locally?

A: Each repository has its own test suite:

A2A Security:

cd a2a-security
pip install -e ".[dev]"
pytest

CLI:

cd capiscio-cli
npm install
npm test

Q: How do I preview documentation changes?

A: Use MkDocs serve:

pip install -r requirements-docs.txt
mkdocs serve
# Visit http://localhost:8000

Still Need Help?¶

If you can't find what you're looking for:

Search existing GitHub Issues
Check the A2A Specification
Open a new issue with details about your problem

We're here to help! 🤝