Flush a specific cache by its ID to invalidate and reset cached data.
Flush a specific cache.
POST /api/v1/settings/cache/{cacheId}/flush
Args: cache_id: Path parameter.
| Name | Required | Description | Default |
|---|---|---|---|
| cache_id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate idempotentHint=true and destructiveHint=false, and the description adds little beyond the literal action of flushing. It does not disclose side effects, what happens to cached data, authentication requirements, or any operational consequences.
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 short and front-loaded with the key purpose. The endpoint and Args lines are somewhat redundant with the schema and tool name, but the overall structure is compact and easy to scan.
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 one-parameter tool with an output schema, this is minimally acceptable. However, it lacks guidance on when to flush a cache and what effect the operation has, leaving the agent to infer important behavioral context.
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%, so the description needed to compensate, but it only says "cache_id: Path parameter." This adds no real meaning beyond the schema's property name and title, leaving the semantics of the cache_id value unexplained.
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 states a specific verb and resource: "Flush a specific cache." This clearly identifies the operation and distinguishes it from the many other settings-related sibling tools, though it does not explicitly contrast itself with alternatives.
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?
No guidance is given about when to use this tool versus alternatives, conditions that require flushing a cache, or any prerequisites. The description merely restates the action without explaining context or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.