Measure an applied improvement
compare_article_improvementCompare search performance before and after an applied improvement and record the result.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | ||
| projectId | Yes | ||
| improvementId | Yes |
compare_article_improvementCompare search performance before and after an applied improvement and record the result.
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | ||
| projectId | Yes | ||
| improvementId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false, destructiveHint=false, openWorldHint=false, so the agent already knows this writes without being destructive. The description adds 'record the result,' clarifying that it persists output rather than just returning a comparison, but it does not say what is stored, whether prior measurements are overwritten, or what the measurement window is.
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 front-loaded sentence with no filler or repetition. It is efficient, though its brevity borders on under-specification given the gaps elsewhere rather than reflecting deliberate tightness.
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 write tool with no output schema and three fully undocumented parameters, the agent lacks key information: what metric is compared, over what window, and what the recorded result consists of. The annotations cover the safety profile, but the description does not compensate for the missing parameter and outcome detail.
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% across three required parameters (projectId, siteId, improvementId). The description only obliquely ties to improvementId via 'applied improvement' and says nothing about projectId or siteId or their relationships, leaving the schema undocumented in both structured and prose form.
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 (compare) and resource (search performance before/after an applied improvement) plus the side effect of recording the result, which distinguishes it from siblings like generate_article_improvement or decide_article_improvement. However, it does not explicitly name those siblings or contrast the measurement role against them.
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 phrase 'an applied improvement' implies a precondition (the improvement must already be applied, presumably via apply_article_improvement), which gives implied usage context. But there is no explicit when-to-use statement and no alternatives named, so an agent must infer the sequencing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.