agentleFS
ralphkraussralphkrauss/agent-orchestrator/AGENTS.md

agent-orchestrator

AGENTS.md4 starsChanged 6 months agoMITView on GitHub

This repository publishes @ralphkrauss/agent-orchestrator, a standalone MCP server for coordinating local Codex and Claude worker CLI runs through a persistent daemon. The 0.3.0 release (issue #63) adds the orchestrationrun engine — a daemon-managed state machine that drives short-lived orchestrator / reviewer / compactor turns through a typed action protocol, with persistent state, lifecycle pub/sub, and MCP / IPC / CLI / opt-in HTTP+SSE transports. The supervisor surfaces (agent-orchestrator claude / opencode / supervisor, the supervisor hooks.json, the orchestrators snapshot block,…

  • Reads credentials
  • Installs packages

We split this AGENTS.md into the rules it gives an agent

11 rules. About 3 are common, 8 are distinctive, and 0 are very specific to this project.

  • ≈3

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the repository scripts:

    line 24
  2. Distinctive:

    Read the existing TypeScript, tests, and docs before introducing new patterns.

    line 44
  3. Distinctive:

    Prefer the repository's existing plain TypeScript style and Node built-ins.

    line 46
  4. Distinctive:

    Keep public package behavior stable unless the task is explicitly about an API or contract change.

    line 47
  5. Distinctive:

    Add or update focused tests for daemon lifecycle, run-store persistence, backend invocation, MCP contracts, and release behavior when those …

    line 49
  6. Common:

    Do not commit, push, publish, deprecate npm versions, activate hooks, install packages, change secrets, or write to external services …

    line 52
  7. Distinctive:

    Treat uncommitted changes as user-owned unless you made them during the current task.

    line 55
  8. Distinctive:

    Never place real tokens in repo files, MCP config, docs, examples, or command arguments.

    line 78
  9. Distinctive:

    When the user explicitly asks to inspect a local test orchestration_run, read from the daemon's stores rather than guessing from memory.

    line 92
  10. Common:

    Keep excerpts minimal. Summarize relevant actions, reviewer verdicts, and worker outcomes.

    line 105
  11. Common:

    Ask before changing release, secret, hook, or external-service behavior.

    line 113

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Orchestrator

Project Overview

This repository publishes @ralphkrauss/agent-orchestrator, a standalone MCP server for coordinating local Codex and Claude worker CLI runs through a persistent daemon. The 0.3.0 release (issue #63) adds the orchestration_run engine — a daemon-managed state machine that drives short-lived orchestrator / reviewer / compactor turns through a typed action protocol, with persistent state, lifecycle pub/sub, and MCP / IPC / CLI / opt-in HTTP+SSE transports. The supervisor surfaces (agent-orchestrator claude / opencode / supervisor, the supervisor hooks.json, the orchestrators snapshot block, and the register_supervisor IPC family) were removed in this release; see CHANGELOG.md 0.3.0 entry for the migration pointers.

For the orchestration engine: see docs/orchestration.md, docs/workflows.md, docs/orchestration-http-transport.md, and docs/development/orchestration-internals.md.

Build And Test

Use the repository scripts:

pnpm install --frozen-lockfile
pnpm build
pnpm test
pnpm verify

pnpm verify is the release-quality check. It builds, runs tests, checks publish readiness, audits production dependencies, resolves the npm dist-tag, and runs an npm pack dry run.

Agents may run pnpm install --frozen-lockfile when dependencies are missing and verification requires them, because the frozen lockfile prevents dependency resolution changes. Do not run other install commands or change dependency ranges unless explicitly asked.

Development Rules

  • Read the existing TypeScript, tests, and docs before introducing new patterns.
  • Prefer the repository's existing plain TypeScript style and Node built-ins.
  • Keep public package behavior stable unless the task is explicitly about an API or contract change.
  • Add or update focused tests for daemon lifecycle, run-store persistence, backend invocation, MCP contracts, and release behavior when those areas change.
  • Do not commit, push, publish, deprecate npm versions, activate hooks, install packages, change secrets, or write to external services unless explicitly asked.
  • Treat uncommitted changes as user-owned unless you made them during the current task.
  • Record concrete evidence when claiming that builds, tests, audits, or publish checks passed.

Release Notes

Release process documentation lives in PUBLISHING.md.

  • Prereleases publish to the npm next dist-tag.
  • Stable releases publish to the npm latest dist-tag.
  • GitHub Actions publishes from matching v*.*.* tags.

MCP Tooling

Repository MCP setup is documented in docs/development/mcp-tooling.md.

  • GitHub API access is configured through the github MCP server.
  • GitHub CLI access is configured through the repo-local gh MCP wrapper.
  • Secret-bearing MCP launches go through scripts/mcp-secret-bridge.mjs.
  • The bridge resolves GITHUB_TOKEN from a user-level secrets file, process environment, or the local gh auth token result.

Never place real tokens in repo files, MCP config, docs, examples, or command arguments.

AI Workspace

  • Shared skills live in .agents/skills/.
  • Cross-cutting rules live in .agents/rules/.
  • Reusable agent definitions live in .agents/agents/.
  • Generated Claude and Cursor projections are produced by scripts/sync-ai-workspace.mjs; edit .agents/ instead.
  • Longer workspace documentation lives in docs/ai-workspace.md.

Local Orchestration-Run Debugging

When the user explicitly asks to inspect a local test orchestration_run, read from the daemon's stores rather than guessing from memory.

  • Resolve the local test home with node scripts/local-orchestrator-home.mjs or just local-home.
  • Orchestration run records live under <local-home>/orchestration_runs/<orchestration_run_id>/ — meta.json, actions.jsonl, handoff.json, pending_inputs.jsonl, children.json, workers.json, groups.json, compactions.jsonl, workflow.json. Prefer daemon MCP tools (get_orchestration_run, list_orchestration_runs, subscribe_orchestration_events) when the daemon is reachable.
  • Worker run records live under <local-home>/runs/<run_id>/; prefer daemon MCP tools such as get_run_progress, get_run_events, and get_run_result.
  • Keep excerpts minimal. Summarize relevant actions, reviewer verdicts, and worker outcomes; never paste secrets or credentials.

Before Implementing

  1. Inspect the affected source, tests, and docs.
  2. Identify the narrowest relevant verification command.
  3. Load relevant rules from .agents/rules/.
  4. Ask before changing release, secret, hook, or external-service behavior.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.