Skip to main content
Glama
Sign In
k11 API Functional QA

k11 API Functional QA

Official
by K11-Software-Solutions
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

Write flow

write_flow

Validate and save a YAML API test flow under tests/api/, preserving existing files unless overwrite is explicitly requested.

Instructions

Save a YAML flow under tests/api/ after validating it. Won't overwrite unless asked.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>",
      "content": "<content>"
    },
    "name": "write_flow"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
contentYes
overwriteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose two valuable behaviors a schema cannot: content is validated before writing, and existing files are protected by default ("Won't overwrite unless asked"). It does not say what happens on validation failure, whether the write is atomic, what permissions are needed, or what the call returns.

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

Conciseness4/5

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

Two compact sentences with the destination and validation precondition front-loaded and the destructive-behavior guard second. Nothing is wasted, though the phrasing could be tightened further.

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

Completeness4/5

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

For a three-parameter write tool with no annotations and no output schema, the essentials are covered: validation precedes the write, the target directory is named, and the overwrite risk is addressed. The main remaining gap is error/validation-failure behavior, which matters for a mutation but is a minor omission.

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

Parameters3/5

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 and it only partly does. It implies content is YAML destined for a path under tests/api/ and it clearly explains the overwrite flag's default-deny semantics, but it does not clarify whether 'path' is absolute or relative, whether the tests/api/ prefix is enforced, or what format validation expects.

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 gives a specific verb and resource ("Save a YAML flow") plus a concrete location ("under tests/api/") and a precondition ("after validating it"). It is clearly distinct from a drafting or execution tool, though it never names a sibling such as draft_flow to make the contrast explicit.

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?

Usage is only implied: the agent can infer it should save a flow only once it is valid, and should pass the overwrite option when replacing an existing file. There is no explicit statement of when to prefer this over draft_flow or run_flows, and no prerequisites are spelled out.

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

Deploy Server

Other Tools