toggle_cprofile

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

No annotations are provided, so the description must disclose all behavioral traits. It covers permission, toggle behavior, and valid values for three parameters. However, it omits side effects, idempotency, and behavior for the 'module', 'owner', and 'func' parameters. The description is insufficiently transparent for a tool with 6 parameters and no schema documentation.

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 three sentences with no redundant information. It front-loads the core purpose and permission, then covers toggle behavior and a brief parameter hint. However, clarity could be improved by explicitly listing all parameters.

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 tool's complexity (6 parameters, toggle behavior, permission requirement) and lack of annotations, the description is incomplete. It fails to explain three parameters, does not describe the output (despite an output schema existing, but not shown), and offers no usage context beyond the toggle action.

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?

Schema description coverage is 0%, so the description must fully explain parameters. It provides valid values ('yes' or 'no') for three parameters (strip_dirnames, print_callees, print_callers) but completely ignores 'module', 'owner', and 'func', leaving their purpose and acceptable values unclear.

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 'Toggle cProfile profiling on/off for a CDV server function.' This is a specific verb+resource pair that distinguishes the tool from its sibling 'get_toggle_cprofile' which likely reads the current state.

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 mentions permission requirement ('Requires sys_viewlogs permission') and explains the toggling behavior, but does not provide guidance on when to use this tool versus checking status via 'get_toggle_cprofile' or other alternative approaches.

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