Skip to main content
Glama
Sign In
tdmcp

tdmcp

by lucasmaher-hash
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Project documentation site

project_documentation_site
Destructive

Generate a multi-file documentation package for a TouchDesigner network, including README, Mermaid topology graph, and optional preview thumbnails, all in one folder to share or archive the project.

Instructions

Compose a one-folder handoff/portfolio documentation PACKAGE for a network: a README.md (title, node count, per-family summary, how-to-load note), a topology.md with a Mermaid graph of the connections, and - when include_thumbnails is set - preview PNGs of output TOPs under thumbs/ linked from gallery.md, all written into out_dir. Unlike generate_readme (a single file), this assembles a small multi-file site folder for sharing or archiving a project.

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": {
      "out_dir": "<out_dir>"
    },
    "name": "project_documentation_site"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNoDocument title. Defaults to the basename of parent_path when blank.
out_dirYesFolder to write the documentation package into (relative or absolute).
parent_pathNoThe network to document (project or COMP), e.g. /project1 or /project1/myComp./project1
max_thumbnailsNoMaximum number of output-TOP previews to capture when include_thumbnails is set.
include_thumbnailsNoCapture preview PNGs of output TOPs into thumbs/ and link them in gallery.md.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.13.1

TDQS

A4.4/5.0
Behavior3/5

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

Annotations already flag this as potentially destructive (readOnlyHint=false, destructiveHint=true). The description adds the concrete behavior of writing multiple files into out_dir and conditionally generating thumbnails, but it does not clarify whether existing files in out_dir are overwritten or deleted, which is a notable gap given the destructive hint.

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, no filler. The first sentence efficiently packs the purpose and file inventory; the second contrasts with a sibling. Every word earns its place.

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?

The description enumerates all generated files and their contents, the conditional thumbnails, and the output directory. It doesn't discuss overwrite behavior or prerequisites, but for a documentation writer, the key details are present. Output schema absence is mitigated by the detailed package structure description.

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?

All 5 parameters have schema descriptions (100% coverage), so the baseline is 3. The description adds meaning by explaining that include_thumbnails triggers PNG generation linked from gallery.md, and that all files are written into out_dir, going slightly beyond the schema's property descriptions.

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 it 'compose[s] a one-folder handoff/portfolio documentation PACKAGE for a network' and enumerates the outputs (README.md, topology.md, thumbnails). It also explicitly contrasts with sibling generate_readme, making the tool's scope unambiguous.

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?

Names generate_readme as the alternative and explains the difference ('a single file' vs 'a small multi-file site folder'), with an explicit use case: 'for sharing or archiving a project.' This gives the agent a clear selection criterion.

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