clash.rules.inspect

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

Declares read-only nature and describes return values: 'ruleset fingerprint, paginated rules with per-rule fingerprints, and MATCH position'. No annotation coverage, but description adequately covers behavioral traits.

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?

Four concise sentences with no redundancy. Front-loaded with purpose, then key details, then alternative tool reference.

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 purpose, read-only, pagination, source options, section behavior, and alternative tool. Lacks exact return format details but mentions key return elements. Adequate given no output schema.

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?

Adds context beyond schema for 'source' (explains 'rules' source and Verge template), 'section' (which parts), and 'targetProfileUid' (defaults to active, supports inactive). Schema coverage is 100%, but description enhances understanding.

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 the verb 'inspect' and the resource 'rules' from multiple sources (profile, merge, rules, runtime). It distinguishes from sibling tools like clash.config.get_effective for runtime rules.

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?

Explicitly provides when to use alternative: 'For runtime rules use clash.config.get_effective with section="rules"'. Also explains source='rules' behavior and section parameter usage.

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