pmg_ruledb_digest

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

With no annotations, the description must disclose behavior. It declares 'READ-ONLY' (no modification), describes the return value as 'a dict with the current hash', and implies cheapness. It does not detail idempotency or rate limits, but the read-only nature is clear. Slight room for more specifics on side effects, but sufficient.

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, no wasted words. The purpose, config requirement, return value, and usage guidance are all front-loaded. Every sentence earns its place.

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?

For a simple tool with one optional parameter, no required parameters, and an output schema, the description covers all essential aspects: purpose, return value, prerequisite, and use case. It is complete and well-integrated with sibling tools.

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 100%, so the schema already describes the parameter. The description adds the context that it 'Needs PROXIMO_PMG_* config', which hints at configuration requirements beyond the schema. This adds marginal value, justifying above the baseline of 3.

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 is a READ-ONLY tool to 'get the PMG RuleDB digest (change-detection hash)'. The verb 'get' and resource 'PMG RuleDB digest' are specific. It distinguishes from the sibling tool pmg_ruledb_rules_list by noting its use for cheap drift detection.

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?

It explicitly states the prerequisite: 'Needs PROXIMO_PMG_* config.' It provides a clear use case: 'poll it to detect drift cheaply instead of re-fetching pmg_ruledb_rules_list.' This gives both usage context and an alternative.

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