Shannon: Instructions file for Claude Code

CLAUDE.md

Shannon CLAUDE.md is an instructions file for Claude Code from Kocoro-lab/Shannon. It costs 1,717 tokens per session, scanned A, original, MIT.

Repository guidance for working on Shannon, a distributed software platform built from Rust, Go, and Python services. It lists setup, run, testing, code-generation, and local Docker commands.

In plain words
What is it for?
Use it to set up Shannon, start its development environment, run smoke and unit tests, regenerate protocol files, run CI checks, and build or start local Docker services.
Why use it?
It gives a coding agent the project context and the commands needed to develop and check changes across several programming languages and services.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is Kocoro-lab/Shannon's own configuration. It tells Claude Code how to work on Shannon itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything Shannon configures →

About the project

Shannon is a framework for building and running production AI agents that coordinate multiple agents through different execution strategies. It is used by teams that need agent collaboration, token budgets, human approvals, sandboxed code execution, and visibility into agent runs. The catalogue instruction supports working with Shannon.

Kocoro-lab/Shannon · 2,230 stars · on GitHub · shannon.run

Reuse

Borrowing it

Nothing to install: this file belongs to Kocoro-lab/Shannon. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/Kocoro-lab/Shannon/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/Kocoro-lab/Shannon

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for Shannon CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/kocoro-lab/shannon/claude-md.svg)](https://agentmods.dev/instructions/kocoro-lab/shannon/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/kocoro-lab/shannon/claude-md"><img src="https://agentmods.dev/badge/instructions/kocoro-lab/shannon/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,717 This file is loaded in full into every session.
When invoked 1,717 The same file — it is already loaded in full.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01717 $0.01717
Opus 5 $0.00859 $0.00859
Sonnet 5 $0.00343 $0.00343
Haiku 4.5 $0.00172 $0.00172

Measured 8d ago against content hash 36f0b66a8d18, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

Shannon CLAUDE.md scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -sS -X POST http://localhost:8080/api/v1/tasks \
CLAUDE.md · 166 lines

How it starts

The opening of the file, as written. The whole thing — 166 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Shannon is an open-source, enterprise-grade multi-agent AI platform that combines Rust (agent core), Go (orchestration with Temporal), and Python (LLM services) to create a token-efficient, distributed AI system.

Essential Commands

# Setup & Run
make setup && vim .env && make dev         # Setup, configure API keys, start all
make smoke                                # E2E smoke tests
make proto                                # Regenerate proto files after .proto changes
make ci                                   # Run CI checks

# Local Docker Builds
# Pattern: docker build --no-cache -f <Dockerfile> -t <image> .
# Then: docker compose -f deploy/compose/docker-compose.yml up -d <service> --no-build
# Dockerfiles: go/orchestrator/Dockerfile, go/orchestrator/cmd/gateway/Dockerfile,
#              python/llm-service/Dockerfile, rust/agent-core/Dockerfile

# Unit Tests
cd rust/agent-core && cargo test
cd go/orchestrator && go test -race ./...
cd python/llm-service && python3 -m pytest

Project Structure

  • rust/agent-core/: Enforcement gateway, WASI sandbox, gRPC server
  • go/orchestrator/: Temporal workflows, budget manager, complexity analyzer
  • python/llm-service/: LLM providers, MCP tools, agent loop
  • protos/: Shared protocol buffer definitions
  • deploy/compose/: Docker Compose configuration
  • config/: Hot-reload configuration files
  • docs/: Architecture and API documentation
  • scripts/: Automation and helper scripts

API Endpoints (4 Entry Points)

Endpoint Orchestrator? Format Use Case
POST /v1/chat/completions Yes OpenAI-compatible Apps using OpenAI SDK -- auto tool selection, deep research, swarm, strategies
POST /v1/completions No (Proxy) OpenAI-compatible Thin LLM proxy -- single call, no orchestration, caller-supplied tools only
POST /api/v1/tasks Yes Shannon native (sync) Full orchestrator pipeline, sync response
POST /api/v1/tasks/stream Yes Shannon native (SSE) Full orchestrator pipeline, streaming SSE events

Read the full file on GitHub · 166 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 166 lines · 1,717 tokens per session scan A 36f0b66a8d18

Subscribe to this mod's changes

Shannon CLAUDE.md is an instructions file published in the GitHub repository Kocoro-lab/Shannon (2,230 stars, last pushed 2d ago), licensed MIT. It adds 1,717 tokens to every session, about $0.0086 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens