Skip to main content
Glama

search_api

Read-only

Search DaVinci Resolve scripting API methods, settings dictionaries, and enum types by name or documentation text to locate the correct call for an automation task.

Instructions

Search API methods, settings dictionaries and enum types by name or documentation text.

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": {
      "query": "<query>"
    },
    "name": "search_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that the searchable corpus is internal API metadata (consistent with the closed-world hint) but says nothing about match ranking, whether results are truncated by the limit, or what a hit contains.

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?

A single sentence with zero filler, front-loading the verb and the searchable entity types. Nothing needs to be trimmed and nothing is buried.

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 two-parameter, non-destructive search tool with no output schema, the definition covers what is searched and how. The remaining gap is what results look like and how the limit behaves, which is a minor but real omission for a discovery tool whose output shape drives next steps.

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 coverage is 0%, so the description must carry parameter meaning. It usefully clarifies that 'query' is matched against both names and documentation text, but the 'limit' parameter (default 40) is never explained, leaving half the parameters undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (search) plus the exact resource universe: API methods, settings dictionaries and enum types, matched by name or documentation text. This is meaningfully distinct from siblings like list_api_methods or get_api_type, though it doesn't explicitly name that contrast.

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?

Usage is implied by the word 'search' and the two match modes, so an agent can infer this is the discovery tool when it doesn't know an exact name. However, there is no explicit statement of when to prefer this over list_api_methods or get_api_docs, and no exclusions or prerequisites.

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