sync_claude_code_agents

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

With no annotations, the description carries the full burden. It discloses the read-from-files and upsert-to-database behavior, which implies writes may overwrite existing records. However, it does not mention potential deletion of absent agents, error conditions, or whether the operation is idempotent, leaving significant behavioral details unknown.

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

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

The description is two sentences, the first stating the core purpose and the second detailing the pipeline. Every word earns its place, with no filler or repetition. It is well-structured and immediately informative.

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

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

Given the lack of annotations and output schema, the description should ideally mention the return value or potential side effects. It thoroughly explains the synchronization process but omits what the tool returns (e.g., count of upserted agents) and any error scenarios, leaving gaps for an agent deciding how to use the result.

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

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

The input schema already provides descriptions for both parameters (100% coverage), so the baseline is 3. The description adds minor context by showing the default agents directory (.claude/agents/) implying that agentsDir overrides it, but does not significantly enhance the meaning of projectId beyond the schema's 'Project ID'.

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

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

The description clearly states the verb 'Synchronize' with resources 'Claude Code agents' and 'Orchestro database'. It further details the exact process (reads from .claude/agents/, parses YAML and prompts, upserts to sub_agents table), which distinguishes it from siblings like read_claude_code_agents or add_sub_agent.

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

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

The description gives clear context: it's for synchronizing local Claude Code agent files into the Orchestro database. It does not explicitly mention when not to use it or name alternative tools, but the process is specific enough that an agent can infer its intended use.

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