trace_edge

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

Annotations already declare readOnlyHint and idempotentHint. Description adds useful behavioral details like 'snapshot-strict' and lists trace components. No contradiction. Could further explain 'snapshot-strict' for clarity.

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?

Single sentence efficiently conveys all key information: action, resource, what is traced. No unnecessary words.

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?

Covers core functionality but omits parameter descriptions and does not elaborate on 'snapshot-strict' implications. Output schema exists but description could be more complete regarding input parameters and output interpretation.

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?

Input schema has 3 parameters (projectId, projectRef, name) with 0% description coverage. Description does not mention or explain any parameters. It implies name is the function name but lacks clarity on projectId and projectRef.

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?

Description clearly states it traces a handler/edge function, listing specific items (route, app-code callers via fetch/invoke patterns, tables/RPCs, DB triggers). This distinguishes it from sibling tools like trace_file, trace_rpc, trace_table.

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?

Provides clear context on what the tool does and what it covers (callers via ast-grep patterns, DB triggers). However, it does not explicitly state when to use this tool versus alternatives or when not to use it.

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