Skip to main content
Glama

get_api_type

Read-only

Retrieve the full definition of a DaVinci Resolve API type by name, including settings dictionaries, enum aliases, or classes for accurate scripting.

Instructions

Full definition of an API type: a settings dict (e.g. RenderSettings, ProjectSettings, TimelineItemProperties, ClipProperties, TimelineSettings), an enum alias or a class.

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

Input Schema

NameRequiredDescriptionDefault
nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

The annotations already establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful context about the kinds of definitions returned, but does not explain error behavior for unknown names or the shape of the returned definition.

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 a single, front-loaded sentence with no filler. It could be structured slightly better by explicitly leading with the retrieval action, but it is appropriately sized.

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

Completeness3/5

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

For a simple one-parameter read tool with no output schema, the description gives a reasonable high-level account of what is returned. However, it leaves the parameter semantics and return structure underspecified, which matters when an agent must supply the correct type name.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must explain the single `name` parameter. It provides example type names such as RenderSettings and ProjectSettings, which hints at valid values, but it does not state the expected format, namespacing, or where those names come from.

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?

The description clearly identifies the resource: the full definition of an API type, with concrete examples of settings dicts, enum aliases, and classes. The verb is only implied by the tool name, and it does not distinguish itself from siblings such as get_api_docs or search_api.

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

Usage Guidelines2/5

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

There is no explicit guidance on when to use this tool versus get_api_docs, search_api, or list_api_methods. The description also omits prerequisites or conditions for choosing this retrieval path.

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