Skip to main content
Glama

get_workflow_guide

Retrieve the written guide for a specified workflow topic to understand procedures and complete Houdini tasks.

Instructions

Return the written guide for a workflow topic.

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": {
      "topic": "<topic>"
    },
    "name": "get_workflow_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYes
descriptionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.2/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It implies a read, but says nothing about whether topics must match exactly, what happens on an unknown topic, whether the guide is static or generated, or how large the returned text is. For an unannotated tool this is thin.

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

Conciseness3/5

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

A single front-loaded sentence with zero padding, which is structurally clean. But the brevity comes at the cost of under-specification rather than being genuinely economical, so it only reaches minimum viability.

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

Completeness2/5

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

With no annotations, no output schema, and 0% parameter documentation, the description is the only source of guidance and it supplies almost none. An agent lacks the topic vocabulary, the return-shape expectation, and any error semantics needed to invoke this confidently.

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

Parameters1/5

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

Schema description coverage is 0% for both parameters. The description only echoes the word 'topic' without listing valid topic values or format, and the optional 'description' parameter (default empty string) is never explained at all. It adds essentially no meaning beyond the bare schema.

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

Purpose3/5

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

The description names a specific verb and resource ('Return the written guide for a workflow topic'), so the basic action is legible. However, 'workflow topic' is undefined, and with siblings like get_help_page in the catalog, an agent cannot tell from this text which one to reach for. Purpose is clear in isolation but not differentiated.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no mention of what counts as a valid topic, and no indication of how this differs from the help-page sibling. The agent must guess the conditions under which this tool is the right call.

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