Skip to content

INDEX.md

Latest commit

 

History

History
368 lines (284 loc) · 14.5 KB

INDEX.md

File metadata and controls

368 lines (284 loc) · 14.5 KB

atcyrus.com | GitHub: ceedaragents/cyrus

Want access to an advanced Claude Code agent built into Linear that you can run anywhere? Try Cyrus.

Documentation Index

Quick navigation guide for the Teammate/Swarm Feature Analysis.

Start Here

New to this analysis? → README.md

Looking for specific information? → Use the reference guide below

Document Overview

Document Purpose Key Information
README.md Overview and quick start Feature summary, status, key findings
01-permission-modes.md Permission system reference All 6 modes, delegate mode details
02-teammate-tool-schema.md Teammate tool specification 13 operations, complete schema
03-task-management.md Task tools documentation TaskCreate, Get, Update, List tools
04-mailbox-system.md Inter-agent messaging Complete mailbox API, message types
05-architecture.md System architecture How all components fit together
06-what-exists.md Component inventory What's implemented vs. missing
07-file-locations.md Code location reference Line numbers, search patterns
08-modifications-made.md Change log What we modified and why
SOURCE-CODE.md Source code access Links, snippets, how to view
INDEX.md This file Navigation and search

Quick Reference by Topic

Understanding the Feature

"What is the Teammate/Swarm feature?" → README.md - Overview section → 05-architecture.md - High-level overview

"What can it do?" → 02-teammate-tool-schema.md - 13 operations breakdown → 05-architecture.md - Use cases section

"What's the current status?" → README.md - Key findings section → 06-what-exists.md - Complete inventory

Technical Details

"How does permission delegation work?" → 01-permission-modes.md - Delegate mode section → 05-architecture.md - Permission delegation pattern

"How do agents communicate?" → 04-mailbox-system.md - Complete mailbox API → 05-architecture.md - Information flow

"What are task tools?" → 03-task-management.md - Complete task tool documentation → 06-what-exists.md - Task management section

"How is the system architected?" → 05-architecture.md - Component stack, data structures → 06-what-exists.md - Layer-by-layer inventory

Finding Code

"Where is the code?" → 07-file-locations.md - All line numbers → SOURCE-CODE.md - How to access source

"Where is the Teammate schema?" → 07-file-locations.md - Line ~2146, variable qgZ → 02-teammate-tool-schema.md - Complete schema

"Where are the mailbox functions?" → 07-file-locations.md - Mailbox system section → 04-mailbox-system.md - Function details

"How do I search the code?" → 07-file-locations.md - How to search section → SOURCE-CODE.md - Access options

Modifications

"What did you change?" → 08-modifications-made.md - Complete change log → README.md - Quick start section

"How do I enable task tools?" → 08-modifications-made.md - Step-by-step process → 03-task-management.md - Enablement section

"How do I revert changes?" → 08-modifications-made.md - Reverting section

"Is it safe?" → 08-modifications-made.md - Safety considerations

Implementation

"What's missing?" → 06-what-exists.md - Completely missing section → 02-teammate-tool-schema.md - What would be needed

"What works?" → 06-what-exists.md - Fully implemented section → 04-mailbox-system.md - Complete API

"How would I implement it?" → 06-what-exists.md - Implementation sections → 05-architecture.md - What would be needed

Reference Tables

File Locations Quick Reference

Component File Line Variable
Gate Function cli.js 789 nU()
Teammate Tool Name cli.js 2137 sH0
Teammate Schema cli.js ~2146 qgZ
Tool Registration cli.js ~3215 TH1()
Delegate Filter cli.js ~3230 Cz(A)
Mailbox Write cli.js ~1716 SL()
Permission Modes agentSdkTypes.d.ts 304-312 PermissionMode

→ Full table: 07-file-locations.md

Tool Availability

Tool Status Availability
TaskCreate ✅ Enabled After our modification
TaskGet ✅ Enabled After our modification
TaskUpdate ✅ Enabled After our modification
TaskList ✅ Enabled After our modification
Teammate ❌ Not available Schema exists, no implementation

→ Details: 06-what-exists.md

Permission Modes

Mode Prompts User Executes Tools Requires Tmux Allows All Tools
default Yes (selective) Yes No Yes
acceptEdits Limited Yes No Yes
bypassPermissions No Yes No Yes
plan No No (simulated) No Yes
delegate Yes Yes Yes No (coordination only)
dontAsk No Limited No Yes (pre-approved)

→ Full details: 01-permission-modes.md

Teammate Operations

Operation Purpose Status
spawnTeam Create team ❌ Schema only
spawn Launch teammate ❌ Schema only
cleanup Tear down team ❌ Schema only
read Read mailbox ❌ Schema only
write Send message ❌ Schema only
broadcast Message all ❌ Schema only
assignTask Assign work ❌ Schema only
claimTask Self-assign work ❌ Schema only
requestShutdown Request shutdown ❌ Schema only
approveShutdown Approve shutdown ❌ Schema only
rejectShutdown Reject shutdown ❌ Schema only
approvePlan Approve plan ❌ Schema only
rejectPlan Reject plan ❌ Schema only

→ Full specification: 02-teammate-tool-schema.md

Message Types

Type Purpose Schema Status
idle General communication ✅ Defined
permission_request Request permission ✅ Defined
permission_response Respond to request ✅ Defined
shutdown_request Request shutdown ✅ Defined
plan_approval_request Request plan approval ✅ Defined
plan_approval_response Approve/reject plan ✅ Defined
sandbox_permission_request Sandbox permissions ✅ Defined

→ Full details: 04-mailbox-system.md

Component Completeness

Component Status Percentage
Permission System ✅ Complete 100%
Mailbox System ✅ Complete 100%
Task Tools ✅ Complete (we enabled) 100%
Teammate Schema ✅ Complete 100%
Team File I/O ✅ Complete 100%
Teammate Tool Object ❌ Missing 0%
Spawn Implementation ❌ Missing 0%
tmux Automation ❌ Missing 0%
Git Worktree Automation ❌ Missing 0%
UI Integration ❌ Removed 0%
Overall ⚠️ Partial ~60%

→ Full inventory: 06-what-exists.md

Common Questions

Usage Questions

Q: Can I use the Teammate tool right now? A: No, the tool object doesn't exist. Only the schema is defined. → 06-what-exists.md - Teammate tool object section

Q: Can I use task tools? A: Yes, after applying our modification. See enablement guide. → 08-modifications-made.md

Q: Do I need tmux? A: Yes, for delegate mode and (future) Teammate tool usage. → 01-permission-modes.md - Delegate mode

Q: How do I enable delegate mode? A: tmux then claude --permission-mode delegate → 01-permission-modes.md - Usage section

Technical Questions

Q: Why doesn't the Teammate tool work? A: The schema exists but no tool object was created and registered. → 02-teammate-tool-schema.md - Why orphaned

Q: Is the mailbox system functional? A: Yes, 100% complete with all CRUD operations and file locking. → 04-mailbox-system.md

Q: What's the delegate mode for? A: Team leaders coordinate work without directly editing files. → 01-permission-modes.md - Delegate mode → 05-architecture.md - Permission delegation

Q: How would spawn work? A: It would create tmux panes, optionally git worktrees, and start Claude instances. → 05-architecture.md - Scenario: Leader spawns team

Investigation Questions

Q: How was this discovered? A: Through systematic exploration of the SDK source code. → README.md - Investigation timeline

Q: What tools were used? A: Read, Grep, Edit tools in Claude Code, plus bash commands. → 07-file-locations.md - How to search

Q: Why is it disabled? A: Likely incomplete feature, possibly planned for future release. → 06-what-exists.md - Evidence of abandonment

Q: What percentage is complete? A: Approximately 60% - infrastructure done, core implementation missing. → 06-what-exists.md - Summary

Document Dependencies

README.md (start here)
  ├─→ 01-permission-modes.md
  ├─→ 02-teammate-tool-schema.md
  ├─→ 03-task-management.md
  ├─→ 04-mailbox-system.md
  ├─→ 05-architecture.md
  │     ├─→ 02-teammate-tool-schema.md
  │     ├─→ 04-mailbox-system.md
  │     └─→ 06-what-exists.md
  ├─→ 06-what-exists.md
  │     ├─→ 02-teammate-tool-schema.md
  │     ├─→ 04-mailbox-system.md
  │     ├─→ 05-architecture.md
  │     └─→ 08-modifications-made.md
  ├─→ 07-file-locations.md
  │     ├─→ 06-what-exists.md
  │     └─→ 08-modifications-made.md
  ├─→ 08-modifications-made.md
  │     ├─→ 03-task-management.md
  │     ├─→ 06-what-exists.md
  │     └─→ 07-file-locations.md
  └─→ SOURCE-CODE.md
        ├─→ 07-file-locations.md
        └─→ 08-modifications-made.md

Reading Paths

Path 1: Quick Overview (15 min)

  1. README.md
  2. 06-what-exists.md - Summary section
  3. 08-modifications-made.md - Summary section

Path 2: Technical Deep Dive (45 min)

  1. README.md
  2. 05-architecture.md
  3. 04-mailbox-system.md
  4. 02-teammate-tool-schema.md
  5. 06-what-exists.md

Path 3: Implementation Guide (30 min)

  1. 06-what-exists.md
  2. 02-teammate-tool-schema.md - What would be needed
  3. 05-architecture.md - What would be needed
  4. 07-file-locations.md

Path 4: Enabling Task Tools (10 min)

  1. 08-modifications-made.md
  2. 03-task-management.md - Enablement section
  3. 01-permission-modes.md - Delegate mode

Path 5: Understanding Permissions (20 min)

  1. 01-permission-modes.md
  2. 05-architecture.md - Permission delegation
  3. 06-what-exists.md - Permission system section

Search Index

By Keyword

Architecture: 05-architecture.md, 06-what-exists.md Backups: 08-modifications-made.md, SOURCE-CODE.md Broadcast: 02-teammate-tool-schema.md, 04-mailbox-system.md Code Locations: 07-file-locations.md, SOURCE-CODE.md Completeness: 06-what-exists.md, README.md Delegate Mode: 01-permission-modes.md, 05-architecture.md Enable: 03-task-management.md, 08-modifications-made.md File Locking: 04-mailbox-system.md Gate Function: 03-task-management.md, 07-file-locations.md, 08-modifications-made.md Git Worktree: 02-teammate-tool-schema.md, 05-architecture.md, 06-what-exists.md Line Numbers: 07-file-locations.md Mailbox: 04-mailbox-system.md, 05-architecture.md, 06-what-exists.md Messages: 04-mailbox-system.md, 02-teammate-tool-schema.md Modifications: 08-modifications-made.md Operations: 02-teammate-tool-schema.md Orphaned Schema: 02-teammate-tool-schema.md, 06-what-exists.md Permission Modes: 01-permission-modes.md, 05-architecture.md Schema: 02-teammate-tool-schema.md, 03-task-management.md Shutdown: 02-teammate-tool-schema.md, 05-architecture.md Source Code: SOURCE-CODE.md, 07-file-locations.md Spawn: 02-teammate-tool-schema.md, 05-architecture.md, 06-what-exists.md Status: README.md, 06-what-exists.md Task Tools: 03-task-management.md, 06-what-exists.md, 08-modifications-made.md Teammate Tool: 02-teammate-tool-schema.md, 06-what-exists.md tmux: 01-permission-modes.md, 05-architecture.md What Exists: 06-what-exists.md What's Missing: 06-what-exists.md

Version Information

Analysis Date: December 2025 SDK Version: @anthropic-ai/claude-agent-sdk v0.1.72 Package URL: https://www.npmjs.com/package/@anthropic-ai/claude-agent-sdk/v/0.1.72

Need help navigating? Start with README.md

Found something interesting? Check 06-what-exists.md to see if it's documented

Want to make changes? See 08-modifications-made.md for our approach