Skip to main content
Glama

flowzap_get_syntax

Access syntax documentation and examples to write FlowZap Code for creating workflow diagrams, process charts, and CI/CD pipelines.

Instructions

Get FlowZap Code syntax documentation and examples. Use this to learn how to write FlowZap Code for workflow diagrams.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It describes the tool as a 'Get' operation for documentation, which suggests a read-only, non-destructive behavior, but does not specify details like authentication needs, rate limits, or the format of the returned documentation. This leaves gaps in understanding how the tool behaves in practice.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and front-loaded, consisting of two clear sentences that directly state the tool's function and its intended use. Every sentence adds value without unnecessary elaboration, making it efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is adequate but not fully complete. It explains what the tool does but lacks details on behavioral aspects (e.g., response format, error handling) that would be helpful for an agent, especially since no annotations or output schema are provided to compensate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has no parameters (0 params), and schema description coverage is 100%, so the schema fully documents the lack of inputs. The description does not need to add parameter details, and it appropriately focuses on the tool's purpose without redundant information, meeting the baseline for tools with no parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('Get') and resource ('FlowZap Code syntax documentation and examples'), and explains the intended use ('to learn how to write FlowZap Code for workflow diagrams'). However, it does not explicitly differentiate this from its siblings (e.g., flowzap_validate or flowzap_artifact_to_diagram), which might also involve FlowZap Code, so it falls short of a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use this tool ('to learn how to write FlowZap Code'), providing some context for its application. However, it lacks explicit guidance on when not to use it or alternatives among the sibling tools (e.g., when to use flowzap_validate instead), leaving usage somewhat open to interpretation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/flowzap-xyz/flowzap-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server