Skip to main content
Glama

how_to

Read-onlyIdempotent

Read the project format reference covering Project > Scene > Shot fields, units (seconds vs percent), x/z ranges and keyframe tracks before using edit_project, so your edits use valid values.

Instructions

Read-only reference text: the project format (Project > Scene > Shot fields), units (seconds vs percent), x/z ranges and keyframe tracks. Read it once before using edit_project. It doesn't need the app open. For the drawing format of draw_* tools, use describe_drawing.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "how_to"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description still adds context the annotations cannot express: it works without the app running, and it only needs to be read once (implying stable, cacheable content). It stops short of describing size or return structure, but that is a minor gap given the annotation coverage.

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?

Three short sentences, front-loaded with the read-only framing, then the content list, then the sequencing rule, then the sibling redirect. Every sentence carries distinct information and none restates the title or annotations.

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 zero-parameter, no-output-schema documentation tool with full annotation coverage, the description covers what the reference contains and how it relates to edit_project and describe_drawing. Only the rough scope or volume of the returned text is unstated, which is a small omission rather than a blocker.

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 tool takes zero parameters, so the baseline is 4 and there is nothing for the description to disambiguate. It correctly says nothing about arguments rather than padding the definition.

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?

"Read-only reference text" names both the verb (read) and the resource (reference documentation), then enumerates exactly what the text covers: project format hierarchy, units, x/z ranges, and keyframe tracks. It also explicitly disclaims the drawing-format territory by pointing to describe_drawing, so an agent can separate it from that sibling without opening a schema.

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

Usage Guidelines5/5

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

"Read it once before using edit_project" gives an explicit call-order rule with the tool it gates. "For the drawing format of draw_* tools, use describe_drawing" names the alternative and the condition that selects it, covering both when-to-use and when-not-to-use.

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