Краткая сводка по инстансу BPMSoft

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds valuable behavioral context: the result is cached for 5 minutes, which is critical for an agent to know to expect stale data on repeated calls. No contradictions with annotations.

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 three sentences long: first sentence describes output, second adds caching behavior, third provides usage recommendation. No unnecessary words, and the most important information comes first.

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?

Despite no output schema, the description fully explains what the tool returns (collections, entities, counts, custom fields) and adds caching behavior and usage context. For a zero-parameter summary tool, this is complete and actionable.

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?

The tool has no parameters, so the schema coverage is 100% trivially. With 0 parameters, baseline is 4. The description does not need to add parameter semantics, and it correctly omits any.

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 returns a summary overview of the instance, listing collections, main business entities, record counts, user collections, and custom fields. It specifies which entities are included (Contact, Account, etc.) and distinguishes itself from sibling tools like bpm_get_collections by focusing on a high-level summary useful at the start of a dialog.

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 includes a usage tip: 'useful at the very beginning of a dialog with a new instance.' This provides clear context for when to use the tool. It does not explicitly exclude alternatives, but the suggestion is sufficient given the tool's high-level nature.

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