flowzap_artifact_to_diagram
Convert HTTP logs, OpenAPI specs, or code snippets into a FlowZap diagram.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | Preferred view mode | |
| content | Yes | Raw artifact content | |
| artifactType | Yes |
Convert HTTP logs, OpenAPI specs, or code snippets into a FlowZap diagram.
| Name | Required | Description | Default |
|---|---|---|---|
| view | No | Preferred view mode | |
| content | Yes | Raw artifact content | |
| artifactType | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It says 'Convert' but does not clarify whether the operation is read-only, whether it persists or returns a diagram, or whether it has side effects on the source content. The behavioral surface is largely opaque.
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 a single concise sentence with no filler. It front-loads the action and includes the key artifact types, making it easy for an agent to scan and understand the tool's core purpose.
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?
There is no output schema and no annotation coverage, so the description should explain what the agent can expect after conversion. It does not mention the return value, output format, or any constraints on content size or format. The description is adequate for basic awareness but incomplete for fully informed invocation.
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 coverage is 67%, and the description adds some meaning by mapping artifact types to the artifactType enum values. However, it does not explain the expected format of the 'content' field for each artifactType, nor does it expand on how 'view' affects the output beyond the schema's enum values.
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 uses the specific verb 'Convert' and identifies the resource: HTTP logs, OpenAPI specs, or code snippets become a FlowZap diagram. It is clear about the input-to-output transformation, though it does not explicitly contrast itself with the similar-sounding flowzap_export_graph sibling.
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?
Usage context is implied: use this when you have one of the listed artifact types and want a diagram. However, it does not state when to prefer this over siblings like flowzap_export_graph or flowzap_validate, nor does it mention any conditions where it should not be used.
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.