Skip to main content
Glama

td_capture_frame

Read-onlyIdempotent

Capture a single frame from a TOP node, returning resolution, format, and byte size. Optionally include a base64 image or save the frame to disk.

Instructions

Capture a single frame from a TOP node, metadata-first.

Returns resolution, format, and byte size; the base64 image comes back only when confirm=True or save_path is set (behind that gate, so token cost stays near-zero by default). If save_path is set the frame is written to disk TD-side and only metadata + the saved path come back — the cheap visual-verify loop. Ask the user before setting confirm=True because image payloads consume significant model context tokens. Prefer td_screenshot for a quick inline thumbnail; prefer td_capture_and_analyze when you also want cooking state and errors folded into the same call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to a TOP node to capture
confirmNoIf True, include base64 image in response
qualityNoJPEG quality 0.0-1.0
save_pathNoOptional disk destination. When set, TouchDesigner writes the frame to this path and the tool returns metadata + the saved path with NO base64 payload (overrides confirm). Accepts an absolute path under your home directory or a bare filename (saved under ~/.tdpilot/captures/). Extension must be .png/.jpg/.jpeg.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Describes that base64 image is only returned conditionally (confirm=True or save_path), save_path overrides confirm, and token cost is near-zero by default. No contradiction with annotations (readOnlyHint, idempotentHint, etc.).

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?

Well-structured with front-loaded purpose. Every sentence adds essential information without redundancy. Two clear paragraphs covering behavior, token cost, and alternatives.

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 the tool's complexity (4 params, output schema exists), the description covers the key behavioral aspects: token cost, conditional returns, disk writing, and usage preferences. Nothing missing for effective agent usage.

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 substantial meaning beyond schema: explains conditional gating of base64 return, token cost implications, and save_path's role in overriding confirm and writing to disk. Schema coverage is 100%, but description provides critical behavioral context.

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 captures a single frame from a TOP node with a metadata-first approach. It distinguishes itself from siblings by name-dropping td_screenshot and td_capture_and_analyze with specific use cases.

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?

Provides explicit guidance on when to use alternatives (td_screenshot for inline thumbnail, td_capture_and_analyze for cooking state/errors) and advises asking user before setting confirm=True due to token cost.

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/dreamrec/TDPilot'

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