Skip to main content
Glama

get_workflow_template

Retrieve JSON configuration and metadata of a saved workflow template by providing its name.

Instructions

Fetch a saved workflow template's JSON and metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesTemplate name.

Implementation Reference

  • The handler function for the 'get_workflow_template' tool. It reads a saved workflow template JSON file from disk by name and returns its raw contents as text.
    server.tool(
      "get_workflow_template",
      "Fetch a saved workflow template's JSON and metadata.",
      getSchema,
      async (args) => {
        validateName(args.name);
        let raw: string;
        try {
          raw = await fs.readFile(templatePath(store.dir, args.name), "utf-8");
        } catch {
          throw new Error(`Template "${args.name}" not found.`);
        }
        return {
          content: [{ type: "text" as const, text: raw }],
        };
      },
    );
  • The input schema for 'get_workflow_template': expects a single required string parameter 'name' describing the template name.
    const getSchema = {
      name: z.string().describe("Template name."),
    };
  • Registration of the 'get_workflow_template' tool on the MCP server via server.tool() inside registerTemplateTools(), with its schema and handler.
    server.tool(
      "get_workflow_template",
      "Fetch a saved workflow template's JSON and metadata.",
      getSchema,
      async (args) => {
        validateName(args.name);
        let raw: string;
        try {
          raw = await fs.readFile(templatePath(store.dir, args.name), "utf-8");
        } catch {
          throw new Error(`Template "${args.name}" not found.`);
        }
        return {
          content: [{ type: "text" as const, text: raw }],
        };
      },
    );
  • Helper function templatePath() used to build the file path for a given template name.
    function templatePath(dir: string, name: string): string {
      return path.join(dir, `${name}.json`);
    }
  • Helper function validateName() used to validate the template name against the allowed pattern.
    function validateName(name: string): void {
      if (!TEMPLATE_NAME_PATTERN.test(name)) {
        throw new Error(
          `Invalid template name "${name}". Must start with alphanumeric; only letters, digits, '-', '_' allowed; max 64 chars.`,
        );
      }
    }
Behavior2/5

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

No annotations are provided. The description mentions it fetches data but does not disclose any behavioral traits like authentication, error handling, or rate limits.

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?

A single concise sentence that immediately conveys the tool's purpose with no unnecessary words.

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?

While minimal and functional, the description lacks details on error handling, return format specifics, or how it differs from list_workflow_templates, leaving some gaps in completeness.

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?

Input schema coverage is 100% with a description for the only parameter. The description adds no extra meaning beyond the schema, so baseline score applies.

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

Purpose5/5

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

The description clearly specifies the verb 'fetch', the resource 'saved workflow template', and the outputs 'JSON and metadata', distinguishing it from siblings like list_workflow_templates and run_workflow_template.

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?

No guidance on when to use this tool vs alternatives such as list_workflow_templates or run_workflow_template. The description only states what it does without context.

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/miller-joe/comfyui-mcp'

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