Skip to main content
Glama

generate_sop_guide

Generate a clean, structured Standard Operating Procedure (SOP) or training walkthrough document with timestamped video checkpoints from a QuickCast session.

Instructions

Generate a clean, structured Standard Operating Procedure (SOP) or training walkthrough document with timestamped video checkpoints from a QuickCast session.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoOptional custom document title.
session_idNoOptional session ID. If omitted, uses latest recording.
session_dataNoOptional raw session JSON string.
workflow_nameNoName of the workflow (e.g. "Customer Refund Process in Admin Panel").

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
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 mentions output content ('clean, structured... with timestamped video checkpoints') but omits permissions, side effects, whether it writes files, required session context, or any safety profile.

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 a single, front-loaded sentence with no wasted words. It efficiently conveys the core action and output.

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 output schema and no annotations, the description should compensate more. It does not explain what happens when optional parameters are omitted, what the generated document contains beyond a high-level phrase, or what the return value looks like.

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 100%, so the schema already documents all four parameters. The description adds no additional meaning or syntax for any parameter, which matches the baseline of 3 when the schema does the heavy lifting.

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 states a specific verb ('Generate') and resource ('Standard Operating Procedure (SOP) or training walkthrough document') with additional qualifiers ('timestamped video checkpoints from a QuickCast session'). This clearly distinguishes it from sibling tools like format_github_bug_report, scaffold_playwright_test, and ingest_session.

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?

The description only states what the tool does; it gives no explicit when-to-use guidance, prerequisites, or alternatives. There is no indication of when to choose this tool over list_recent_sessions, get_latest_session, or other siblings.

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