Lists all Data Provider identifiers, such as DP0 and DP1, in a Web Intelligence document using the document ID.
Lists all Data Provider identifiers (e.g. 'DP0', 'DP1') within a Webi document.
| Name | Required | Description | Default |
|---|---|---|---|
| webi_doc_id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It implies a safe read ('Lists') scoped to one document and shows the identifier format, but says nothing about permissions, ordering, or behavior on documents with no Data Providers.
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?
A single tight sentence with the resource front-loaded and the example identifiers placed where they aid recognition. No filler, though it is arguably too terse given the gaps elsewhere.
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?
An output schema exists, so return values need not be explained. For a simple single-parameter list tool that is nearly enough, but the absence of any routing guidance among six DP-related siblings leaves a real gap.
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?
One parameter with 0% schema description coverage. The phrase 'within a Webi document' indirectly signals that webi_doc_id identifies the document to enumerate, but the description never states the parameter name, its expected format, or what happens with an invalid ID.
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?
States a specific verb and resource ('Lists all Data Provider identifiers') plus a clear scope ('within a Webi document') and example identifier formats. The plural 'identifiers' implicitly distinguishes it from sibling get_dp_details, but no sibling is named or contrasted explicitly.
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 contains no when-to-use guidance, no prerequisites, and no mention of the obvious alternatives (get_dp_details, get_dp_sql, get_dp_specification) despite a dense sibling set. An agent must infer that this is the enumeration step before drilling into a specific DP.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.