read
Read a file stored on a MicroPython board to inspect its contents or debug code directly on the device.
Instructions
Read a file stored on the board.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes |
Read a file stored on a MicroPython board to inspect its contents or debug code directly on the device.
Read a file stored on the board.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes |
Changes observed during successful MCP inspections.
v0.1.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
There are no annotations, so the description must disclose behavioral details on its own. It conveys a read-only intent, but it does not describe the return value, effects, permissions, or failure behavior.
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 one focused sentence with no filler. It is concise and front-loaded, though it could be somewhat richer without becoming verbose.
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?
With no annotations and no output schema, the description should clarify expected outcomes. It names the action but leaves the actual file contents/return behavior and path semantics to inference, making it minimally viable rather than complete.
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 must compensate. It adds only the minimum context that 'path' refers to a file on the board; it does not explain path format, accepted file types, or how the path maps to the board's filesystem.
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 names a specific verb ('Read') and resource ('a file stored on the board'), so the core operation is immediately understandable. It does not explicitly differentiate from sibling tools like 'open' or 'info', so it misses the top score.
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 usage context is provided. The description does not say when to prefer 'read' over siblings such as 'open', 'info', 'ls', or 'write', nor does it mention any prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.