hide_filter

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 actual mechanism (sets the isHiddenInViewMode flag) and the key behavioral nuance (filter still applied to the report). It also clarifies matching by table[field]. This goes beyond a simple statement of purpose.

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?

Three sentences, front-loaded with the capitalized action HIDE and packed with necessary detail: scope requirements, matching, and flag effect. No redundant phrasing.

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 the action, scope constraints, matching mechanism, and the resulting state. Missing edge-case behavior (e.g., filter not found) and the false case of hidden, but given no output schema and moderate complexity, this is adequate for an agent.

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 86%, so the schema already documents most parameters. The description adds crucial relationship semantics (scope=visual requires page+visual; scope=page requires page) and matching logic (table[field]) that are not in the schema. It doesn't explain the hidden parameter, but the schema default and the HIDE wording cover that.

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 it HIDEs a filter in view mode, explaining that the filter remains applied but is not shown to viewers. This specific verb+resource+outcome distinguishes it from siblings like 'remove_filter' and 'lock_filter'.

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 when to use: when you want to hide a filter from the filter pane while still applying it. It also specifies scope-specific requirements (visual needs page+visual, page needs page). However, it doesn't explicitly name alternative tools.

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