inspect_ip_params

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

With no annotations, the description carries the full burden. It explains it retrieves CONFIG.* properties via Tcl API and supports filtering, but does not explicitly state it is read-only/non-destructive, nor mention behavior on invalid IP names or missing sessions. The description adds some value but lacks safety and error context.

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 concise, with a clear two-sentence overview followed by an Args list. All information is relevant and front-loaded; no wasted 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?

The tool has 3 params and no annotations, but the description covers purpose, method, and parameter semantics. Output schema exists so return values are not needed. Minor gaps: no mention of session validity or error behavior, but overall adequate for a read-only inspection tool.

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%, and the description fully compensates with an Args section that explains ip_name with an example, filter_keyword with examples and case-insensitivity, and session_id as target session ID. This provides meaning beyond the bare schema.

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 tool queries all configuration parameters (including GUI-hidden ones) for an IP instance, using a specific verb (查询/inspect) and resource (IP config params). This distinguishes it from siblings like run_synthesis or get_io_report, which focus on other objects.

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 implies usage for inspecting IP configuration but does not explicitly state when to prefer this over alternatives or mention conditions like requiring an active session. No exclusions or alternative tool references are provided.

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