Skip to main content
Glama

Start Companion Run

companion_start

Start a background Claude Code companion run in your project directory, returning a run ID to monitor progress via companion_status, recent, or result endpoints.

Instructions

Start a background Claude Code companion run for this cwd. Returns quickly with runId; use companion_status/recent/result to monitor.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cwdNoProject working directory. Defaults to the MCP server cwd.
modeNoSDK backend: read-only denies mutating tools; workspace-write may edit files. TUI backend receives this as visible companion context and still relies on Claude Code CLI/user supervision.
modelNoOptional Claude model override. Omit to use Claude Code defaults.
titleNoHuman-readable companion title.
effortNoOptional Claude effort override. Defaults to high.
promptYesTask or follow-up for Claude Code. Give goals, constraints, and acceptance criteria.
backendNoCompanion backend. sdk is the default managed Claude Agent SDK path; tui opens a native Claude Code CLI in tmux.
maxTurnsNoOptional max agent turns for a single send.
claudePathNoOptional local Claude Code executable path. Defaults to the local `claude` on PATH.
allowedToolsNoOptional auto-allowed Claude Code tools.
maxBudgetUsdNoOptional SDK USD stop-loss cap for a single Claude turn. Omit for normal Claude Max/subscription workflows unless you explicitly want a hard per-turn cap.
maxRuntimeMsNoStop-loss wall clock timeout for a single run.
stallTimeoutMsNoStop-loss timeout when no Claude SDK progress events arrive.
disallowedToolsNoOptional tools removed from use.
tmuxSessionNameNoOptional tmux session name for the tui backend. Defaults to a stable project-derived name.
permissionPolicyNoSDK backend policy: balanced allows local project work and blocks detected out-of-cwd paths; trusted allows all non-disallowed tools; strict allows only allowedTools; bypass uses Claude Code bypassPermissions. TUI bypass starts Claude Code with --dangerously-skip-permissions, but existing TUI panes must be recreated for launch flags to change.
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Without annotations, the description must carry the behavioral disclosure burden. It reveals that the run is background, returns quickly with a runId, and should be monitored via other tools. This conveys asynchronous behavior and the need for polling. However, it does not mention potential side effects like process spawning, resource consumption, or backend-specific behaviors (e.g., tmux sessions for TUI backend), which are covered in the schema but not flagged as important behavioral traits.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is only two sentences and front-loads the primary action. The first sentence states what the tool does; the second explains the return value and directs to monitoring tools. No wasted words. It is ideal in length and structure for a tool with a rich schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 16 parameters and a rich schema, the description is concise but sufficient: it covers the core flow (start, get runId, monitor). It does not explicitly mention the distinction between new runs vs resuming/sending, but sibling names and schema cover that. It also doesn't highlight backend/security considerations, but those are in the schema. The description is complete enough for an AI agent to understand the tool's role without being verbose.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 16 parameters with detailed descriptions. The tool description itself adds no parameter-related information, but the baseline of 3 applies because the schema does the heavy lifting. The description does not need to repeat parameter details, but it also doesn't add any extra semantic context (e.g., which parameters are most commonly used together).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action: 'Start a background Claude Code companion run for this cwd.' This clearly identifies the verb (start), resource (companion run), and scope (current working directory). It also distinguishes itself from sibling tools by mentioning the returned runId and directing to companion_status/recent/result for monitoring, which differentiates it from companion_send or companion_resume.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says to use companion_status/recent/result to monitor after starting, which is clear post-use guidance. However, it does not explicitly state when not to use this tool (e.g., preferring companion_send for follow-ups or companion_resume for existing runs), so it lacks explicit exclusions. Still, the context of 'background run' and 'returns quickly' implies asynchronous starting, which is helpful.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Terry-Wang-Lynx/cc-in-codex'

If you have feedback or need assistance with the MCP directory API, please join our Discord server