Get workspace snapshot
roadflow_getReturn the current workspace as JSON and/or markup.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Default both |
roadflow_getReturn the current workspace as JSON and/or markup.
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Default both |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full responsibility for behavioral disclosure. It doesn't state whether this is a read-only snapshot operation, whether it has side effects, what the JSON/markup represents structurally, or how it differs from a full export. For a tool returning workspace data, this is thin coverage.
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?
One concise sentence that gets straight to the point with no filler. Efficiently sized.
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?
The tool has no annotations and no output schema, so the description must fully explain behavior, which it does not. Sibling ambiguity with export tools, no indication of what 'snapshot' means versus an export, and no behavioral detail all leave significant gaps for such an underspecified tool.
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 100% — the single 'format' parameter with an enum of json/markup/both is fully documented in the schema. The description adds marginal value by mentioning JSON and markup formats, consistent with the parameter, but nothing beyond that.
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 the tool returns the current workspace as JSON and/or markup, which is a clear verb+resource. However, it doesn't distinguish this from sibling tools like roadflow_export_json/export_markup that also produce JSON/markup output, so differentiation from closely-related siblings is absent.
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 when-to-use guidance is provided, and no distinction is drawn from the similarly-named export tools (roadflow_export_json, roadflow_export_markup) or the apply tools. An agent has no basis for choosing this over the export siblings.
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.