Skip to main content
Glama

Write agent guide

write_agent_guide

Emit a project-guide file (CLAUDE.md or AGENTS.md) with tdmcp operator conventions and a dynamic project summary, so future agents have the right mental model. Optionally write to disk.

Instructions

Emit a project-local CLAUDE.md / AGENTS.md seeded with tdmcp operator conventions and TouchDesigner render-coordinate rules, so a future agent working on this project starts with the right mental model. A small dynamic header (project name, node count, top families) is prepended to a curated static body. Pass output_dir to also write the file to disk on the machine running TouchDesigner. The guide is always returned in the structured result.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filenameNoName of the guide file to emit, e.g. CLAUDE.md or AGENTS.md. Defaults to CLAUDE.md.CLAUDE.md
output_dirNoAbsolute path on the machine running TouchDesigner where the guide file should be written. If omitted the guide is returned in the result but not written to disk.
pathNoTouchDesigner project/COMP path to summarise in the guide header, e.g. /project1. A one-line dynamic summary (node count + top families) is prepended to the static body./project1

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
filenameYesName of the guide file.
writtenYesWhether the file was written to disk.
pathNoAbsolute path the file was written to (if written).
guideYesThe full guide markdown text.
Behavior4/5

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

Discloses conditional disk write via output_dir, and that guide is always returned. Annotations indicate non-readonly and non-destructive, consistent. No contradiction.

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?

Two sentences, front-loaded with purpose, no extraneous words. Efficient and structured.

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

Completeness5/5

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

Given output schema exists, description covers key behaviors: writing to disk, returning result, dynamic header. Complete for this tool's complexity.

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

Parameters5/5

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

Adds meaning beyond schema by explaining filename defaults, output_dir optionality, and path's role in dynamic header. Schema coverage is 100% but description enriches.

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 states the tool emits a project-local CLAUDE.md/AGENTS.md with conventions and rules, using specific verbs and resource. It distinguishes from siblings like generate_readme.

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

Usage Guidelines4/5

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

Describes when to use (for setting up project for future agent), but lacks explicit when-not or alternatives. Still clear contextual guidance.

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/Pantani/tdmcp'

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