self_insight

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

Discloses important side effects such as downvote auto-archiving at 0 and the promote threshold. Annotations are not contradicted, and the description adds useful behavioral context beyond the flags.

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 compact and well-structured, using a clear action list and parenthetical modifiers. Every sentence adds useful information without unnecessary fluff.

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 multi-action nature and 8 parameters, the description covers the core action semantics and thresholds well. It does not mention return values or output format, but the lack of an output schema reduces the impact of that omission.

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 coverage is about 50%; the description adds meaning for action-specific behavior and thresholds but does not elaborate on parameters like tags, context, project, or source_error_ids beyond their schema descriptions. Some parameter semantics are left to inference.

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?

Clearly describes managing insights from error patterns and enumerates the concrete actions (add, upvote, downvote, edit, list, promote). This makes the tool's scope obvious and distinct from sibling memory/self tools.

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 explicit trigger conditions for adding and upvoting insights ('Call add when pattern detected', 'Call upvote when insight confirmed again'), giving clear contextual usage. It does not give when-not-to-use guidance for every action, but the main intent is clear.

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