layerfs_operator_workspace_overlay
Retrieve overlay statistics for a mounted workspace to inspect layer changes and storage usage.
Instructions
Read a mounted Workspace's overlay statistics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ws | Yes |
Retrieve overlay statistics for a mounted workspace to inspect layer changes and storage usage.
Read a mounted Workspace's overlay statistics.
| Name | Required | Description | Default |
|---|---|---|---|
| ws | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds only the implicit prerequisite that the workspace be mounted; it does not say what overlay statistics include, how they are returned, or what happens if the workspace is not mounted.
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 restated title. It is efficient, though efficiency here partly reflects under-specification rather than deliberate brevity.
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 read-only statistics tool with a nested, fully undocumented parameter object and no output schema, the description does not explain the metric being read or how to identify the target workspace. It leaves too much for the agent to infer before calling.
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%, and the single nested `ws` object has three undocumented fields (sandbox, path, image). The description only implies that `ws` identifies a mounted workspace and gives no meaning for sandbox, path, or image, leaving the parameter essentially 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?
States a specific verb (Read) and resource (a mounted Workspace's overlay statistics), but 'overlay statistics' is unexplained jargon and nothing distinguishes it from nearby siblings like layerfs_operator_workspace_changes, layerfs_operator_store_stats, or layerfs_operator_files_stats. An agent can tell it is a read of some workspace stats, but not clearly which stats.
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?
There is no when-to-use guidance, no exclusions, and no mention of alternatives among the many statistics/inspection siblings. The only implied precondition is that the workspace be mounted, which is not framed as guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.