Skip to main content
Glama

td_get_hints

Read-onlyIdempotent

Retrieve concise, source-cited hints for a topic, op type, or intent to resolve TouchDesigner problems.

Instructions

Return concise, source-cited hints for a topic, op_type, or intent.

Sources include hint packs shipped under src/td_mcp/hints/packs/ (skill pitfalls, canonical recipes), with future expansion to live knowledge-store essays. Every hint cites its source.

The response shape:

{
  "topic": ...,
  "op_type": ...,
  "confidence": 0.87,
  "hints": [
    {"id": ..., "priority": "critical|useful|context", "rule": ...,
     "source": "tdpilot-core §11", "source_kind": "skill_pitfall"},
    ...
  ],
  "next_tools": ["td_get_param_help", "td_screenshot"],
  "hint_pack_version": "v1.6.0-1",
  "available_topics": [...],
  "available_op_types": [...]
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNoTopic name. Allowed values evolve with the shipped hint corpus; current topics are returned in every response under ``available_topics``. Examples: 'feedback', 'glsl', 'render_pipeline', 'audio_reactive', 'extensions'.
intentNoFree-text description of what you're about to do. Used to score ``intent_match`` clauses on individual hints (e.g. intent='set up trail decay' bumps the level.opacity hint).
op_typeNoOP type to get type-specific hints (e.g., 'glslTOP', 'feedbackTOP', 'geometryCOMP'). Combines additively with ``topic`` when both are set.
surfaceNoOptional response-surface filter (v1.6.2). Allowed values: 'create_node', 'set_params', 'exec', 'errors', 'plan', 'preview', 'query', 'inspect', 'screenshot'. Surface-restricted hints (those declaring ``when.surface``) only fire when the requested surface matches; hints without a surface clause fire from any surface. Auto-injection from each tool wrapper passes the tool's natural surface automatically; explicit callers pass it here to narrow results.
max_hintsNoCap on returned hints. Critical-priority hints win ties.
node_pathNoOptional: path of node about to be modified. Reserved for future hints that compute against live node state.
error_textNoOptional: error/warning text to match against ``error_match`` clauses. Mirrors what auto-injection does after a failed td_get_errors call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

The annotations already mark the tool as readOnly, idempotent, and non-destructive. The description adds substantial context: sources (hint packs, future knowledge-store essays), response shape including confidence, priority, source citations, and auto-injection behavior. This exceeds what annotations alone convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with purpose and structured with a response shape example. It is moderately concise but contains some redundancy with schema descriptions (e.g., parameter details). Still efficient for the complexity.

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 7 parameters, high schema coverage, and an output schema, the description is thorough. It covers response format, sources, filtering (surface), future expansion, and auto-injection. No obvious gaps remain for an agent to use this tool correctly.

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% (all 7 parameters have descriptions). The description itself adds minimal parameter-level meaning beyond the schema, such as examples for topic and intent. Baseline 3 is appropriate as the schema already explains parameters well.

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 starts with a clear verb+resource: 'Return concise, source-cited hints for a topic, op_type, or intent.' This precisely states what the tool does and distinguishes it from sibling tools like td_lookup_snippets or td_search_popx_docs, which serve different retrieval needs.

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

Usage Guidelines3/5

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

While the description provides examples of use (topic, intent, op_type), it does not explicitly state when to use this tool versus alternatives or when not to use it. For a tool with many siblings, more guidance on selection would improve clarity.

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