Imported from talosprotocol/talos (
AGENTS.md). Install upstream withnpx skills add talosprotocol/talos. Copyright stays with the author.
Talos Protocol Master Index & Developer Bible
Welcome to the Talos Protocol, a high-integrity, decentralized communication platform for AI agents. This document is a master directory and guide designed for developers, software engineers, product managers, UX designers, and AI agents operating on or integrating with the Talos Protocol ecosystem.
Use this index as a single entry point ("one-stop index") to find all the specialized architectural, feature, security, and SDK guidelines ("the shops") located throughout the repository.
๐ 1. Getting Started & Mental Models
If you are new to the Talos Protocol or setting up your development environment for the first time, start with these guides:
- quickstart.md: Jump right in with the initial setup instructions and run a simple agent node.
- mental-model.md: Understand the core principles of Mission Control, cryptographic auditability, and peer-to-peer agent coordination.
- talos-60-seconds.md: An ultra-high-level summary of Talos guarantees and components.
- simple-guide.md: A step-by-step developer tutorial.
- one-command-demo.md: Deploy a pre-configured local stack in one step to see Talos in action.
๐๏ธ 2. Architecture & Design Specs
Talos is designed around hexagonal ports and adapters to isolate core protocol logic from external services:
- overview.md: System design, data flows, and relations between the gateway, dashboard, and registry components.
- context_graph.md: The source-derived live map of codebase components, routes, features, and dependencies.
- infrastructure.md: Specifications for deployment targets, databases (Postgres, Redis), and system services.
- wire-format.md: The binary and serialized wire envelope specifications (JWS, frames, header envelopes).
- protocol-guarantees.md: Cryptographic and transaction guarantees provided by the protocol layer.
- fullscale_development_plan.md: Monorepo integration roadmap and feature development plan.
๐ 3. Cryptography, Security & Identity
Security is the core foundation of Talos. Access the technical validation and threat modeling wikis:
- cryptography.md: Detailed specifications of cryptographic primitives (Ed25519 signatures, X25519 key exchange, ChaCha20-Poly1305 symmetric AEAD encryption, and SHA-256 hashes).
- agent-identity.md: Decentralized Identifiers (DIDs) for cryptographic identity verification.
- dids-dht.md: Peer-to-peer discovery using Distributed Hash Tables (DHT) anchored to key DIDs.
- key-management.md: Standardized key formats, storage in local wallets, and credential isolation.
- threat-model.md: Threat profiles, mitigation vectors, and trust boundaries.
- validation-engine.md: Strict schemas and patterns (e.g. UUIDv7, Base64Url) used to validate incoming packets and prevent exploitation.
- mathematical-proof.md: Formal verification and proofs of the cryptographic channel guarantees.
๐ค 4. Peer-to-Peer & Agent Protocols (A2A, UCP, MCP)
Talos integrates three core protocols that define how agents talk, buy, and execute:
Agent-to-Agent (A2A) Secure Messaging
- a2a-channels.md: Overview of secure channels established using self-signed handshakes.
- double-ratchet.md: Implementation details of the Signal Double Ratchet protocol, providing forward secrecy and break-in recovery.
- file-transfer.md: Encrypted file chunking and binary streaming across active ratchets.
- a2a-sdk-guide.md: Practical guidelines for establishing A2A sessions and tracking tasks.
Universal Commerce Protocol (UCP)
- Dynamic Merchant Discovery: Merchant capability sheets located at
/.well-known/ucpdetailing services, endpoints, and payment methods. - Order Tracking: Post-purchase checkout state retrieval, order logs, and compliance hooks.
- Identity Linking: Mapping commerce identities securely to root principal keys in the gateway.
Model Context Protocol (MCP)
- mcp-integration.md: Gateway tunnel architecture that attaches authorization checks to standard MCP calls.
- mcp-cookbook.md: Reference recipes for developing custom MCP servers and binding them to the gateway.
- mcp-proof-flow.md: Cryptographic execution evidence (4-layer artifact model: Identity, Authority, Intent, Execution) proving who performed what tool action when.
๐ป 5. SDK Reference & Integration
Talos provides native SDKs for building secure agents. Use these references:
- sdk-integration.md: Integrations with third-party agent frameworks (e.g. LangChain, AutoGen).
- sdk-ergonomics.md: Design principles behind the client APIs.
- python-sdk.md: Python reference and installation details (
pip install talos-sdk-py). - typescript-sdk.md: TypeScript/JavaScript guide (
npm install @talosprotocol/sdk). - rust-sdk.md: High-performance Rust bindings.
- usage-examples.md & examples.md: Code snippets for wallet creation, message sending, and peer connection.
๐ 6. Observability, Auditing & UI/UX Design
Monitoring autonomous workflows requires specialized UI patterns. Use these resources:
- audit-scope.md: Scope of the immutable events recorded to the ledger.
- audit-use-cases.md: Forensic verification scenarios and compliance reporting.
- audit-explorer.md: Querying the ledger via TUI, Dashboard, and API.
- observability.md: Distributed tracing (Jaeger), Prometheus metrics, and system instrumentation.
- security-dashboard.md: System Threat Level states (SECURE, ELEVATED, CRITICAL), visual indicators, and proof drawer verification badges (VERIFIED vs REMEDIATION REQUIRED).
โ๏ธ 7. Operational Governance & Budgets
Preventing runaway agents and key compromisals at runtime:
- adaptive-budgets.md: Hierarchical budgeting (Team USD limits and Virtual Key warning/hard thresholds) with real-time reserve and settle flows.
- secrets-rotation.md: Automated Key Encryption Key (KEK) rotation, versioned envelopes, and active grace periods to prevent runtime disruptions.
- global-load-balancing.md & multi-region.md: Resilient failovers and read-replica sync models.
๐ ๏ธ 8. Monorepo Directory & Submodule Index
The Talos Protocol consists of multiple interconnected modules:
- contracts/: Central source of truth for schemas, test vectors, and wire models.
- core/: Core cryptographic engine and message transport.
- docs/: Documentation submodule containing architectural specifications, guides, and reference manuals.
- services/ai-gateway/: Secure gateway enforcing RBAC, budgets, and MCP tools.
- services/audit/: Immutable, Merkle-tree event database.
- services/ucp-connector/: Bridge to external commerce APIs.
- services/mcp-connector/: MCP tool connector.
- sdks/: Language SDK implementations (Python, TypeScript, Go, Java, Rust).
- site/dashboard/: Next.js system control dashboard.
- tools/talos-tui/: Interactive Terminal UI (TUI) for administration.
๐ 9. Engineering & Contribution Reference
Guidelines for extending the codebase and adding features:
- development.md: Local development setup, database migrations, and hot-reload configs.
- testing.md: Testing frameworks (pytest, vitest), coverage rules, and integration checks.
- test-manifests.md: Writing test metadata manifests (
.agent/test_manifest.yml). - a2a-v1-rollout.md: PR sequencing and migration path guidelines.
- contributing-template.md: Code contribution checklists, naming conventions, and pre-commit validation hook requirements.
- decision-log.md: Historic design choices and consequences.
- glossary.md: Domain terminologies.
๐งช 10. Factual Status & Roadmap (Known Gaps)
To maintain strict compliance and factuality, please note the status of the following features:
- A2A Group Channels: Planned. Standardized group messaging schemas are documented, but the multi-party ratchet exchange is not yet fully implemented.
- Policy Engine (Cedar/OPA Integration): Planned (DEC-015). Currently, gateway authorization rules are evaluated using declarative JSON/dict structures. Integration of third-party policy engines is on the roadmap.
- Post-Quantum Cryptography Migration: Planned (DEC-017). Standard primitives are restricted to Ed25519 and X25519.
- P2P NAT Traversal / WebRTC: Planned (DEC-004). Peer-to-peer discovery runs via the registry. Direct WebRTC P2P fallback channels are under research.