README.md

March 25, 2026 ยท View on GitHub

AgenC

AgenC banner

Developer documentation front door for the full AgenC project.
This workspace contains the umbrella repo plus the canonical nested repos that make up the product, protocol, SDK, plugin ABI, and prover surfaces.

Website Documentation Telegram X

CA: 5yC9BM8KUsJTPbWPLfA2N8qH1s9V8DQ3Vcw1G6Jdpump

Start Here

If you are working on AgenC as a developer, use this doc set first:

Workspace At A Glance

RepoRoleKey surfaces
AgenCWorkspace root and developer-doc indexroot docs, bootstrap scripts, public examples, boundary checks
agenc-coreFramework/runtime/operator implementation reporuntime/, mcp/, docs-mcp/, packages/agenc/, web/, mobile/, demo-app/, internal examples, operator tools
agenc-protocolProtocol and trust-surface source of truthAnchor program, canonical artifacts, migrations, verifier/router IDL, zkVM guest, @tetsuo-ai/protocol
agenc-sdkPublic integration SDK@tetsuo-ai/sdk, proof/task/query helpers, tests, API baseline, starter example
agenc-plugin-kitPublic plugin authoring ABI@tetsuo-ai/plugin-kit, compatibility matrix, certification harness, starter template
agenc-proverSeparate proving and admin repoproving server, guest/method crates, private admin tools

Current Checkout Layout

AgenC/
  docs/
  examples/
  scripts/
  assets/
  agenc-core/
  agenc-protocol/
  agenc-sdk/
  agenc-plugin-kit/
  agenc-prover/

The root repo is the umbrella workspace and documentation hub. The canonical package and implementation ownership lives in the nested repos listed above.

Public Packages And Operator Surfaces

SurfaceCanonical repoNotes
@tetsuo-ai/sdkagenc-sdkApp/service integration SDK
@tetsuo-ai/protocolagenc-protocolReleased protocol artifacts and IDL package
@tetsuo-ai/plugin-kitagenc-plugin-kitPlugin/add-on authoring boundary
@tetsuo-ai/agencagenc-corePublic CLI/launcher package for the framework install path
@tetsuo-ai/runtimeagenc-coreImplementation runtime package; not the end-user install identity
@tetsuo-ai/mcpagenc-coreRuntime-side MCP server package
@tetsuo-ai/docs-mcpagenc-coreDocs indexing/search MCP package

Common Entry Paths

I need to...Start here
Understand the whole projectdocs/DEVELOPER_GUIDE.md
Find the repo or folder that owns a surfacedocs/CODEBASE_MAP.md
Run setup or validationdocs/COMMANDS_AND_VALIDATION.md
Find the canonical docs for a subsystemdocs/DOCS_INDEX.md
Understand reviewed public-task settlementagenc-protocol/docs/TASK_VALIDATION_V2.md and agenc-core/docs/RUNTIME_API.md
Work on protocol contracts or Anchor artifactsagenc-protocol/docs/DOCS_INDEX.md
Work on the framework/runtime/operator stackagenc-core/docs/DOCS_INDEX.md
Work on the public SDKagenc-sdk/docs/DOCS_INDEX.md
Work on the plugin ABIagenc-plugin-kit/docs/DOCS_INDEX.md
Work on proving/admin flowsagenc-prover/docs/DOCS_INDEX.md

Root Validation

From the workspace root:

npm install --no-fund
npm run validate:umbrella

That validates the root docs/examples/bootstrap contract. It does not replace the repo-specific validation commands documented in docs/COMMANDS_AND_VALIDATION.md.

Public Examples

The root repo keeps only public-surface-safe examples:

Run them from the root with:

npm run example:simple-usage
npm run example:tetsuo-integration
npm run example:risc0-proof-demo
npm run example:helius-webhook:server
npm run example:helius-webhook:subscribe

The Helius example requires HELIUS_API_KEY, and the server entrypoint also requires HELIUS_WEBHOOK_SECRET.

The reviewed-task walkthrough stays documentation-only until a published @tetsuo-ai/sdk release exposes the reviewed helper surface used by Task Validation V2.

License

GPL-3.0. See LICENSE.