Skip to main content
Glama

get_api_docs

Read-only

Retrieve Blackmagic scripting API documentation as a table of contents, a specific section by heading name, or the full README to find DaVinci Resolve scripting details.

Instructions

Blackmagic's scripting README: 'TOC' for its headings, a heading name for one section (e.g. 'Audio Mapping', 'Looking up Project and Clip properties'), or '' for everything.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_api_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionNoTOC

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/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 content is a local README organized by headings, which is useful context, but says nothing about return size, format, or whether the full README may be very large when section is ''.

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

Conciseness3/5

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

It is a single compact sentence with no filler, but the phrasing is dense and slightly cryptic ('TOC' for its headings) and reads as a live parameter enumeration rather than a front-loaded statement of purpose. It could lead with the verb and then list modes.

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?

There is no output schema, so the description should indicate what comes back – presumably README markdown text – and it does not, nor does it warn about response size for the '' option. For a simple one-parameter read tool this is adequate but has an obvious gap.

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?

Schema description coverage is 0%, so the description carries the full burden and does it well: it explains all three meaningful values of the single 'section' parameter, including the default TOC behavior, a named-heading lookup, and the empty-string 'everything' case. It does not give examples of exact heading spellings beyond two samples, keeping it just short of a 5.

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

Purpose3/5

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

The description identifies the resource ('Blackmagic's scripting README') but never states a verb or what the tool actually returns; the agent must infer from the name that it retrieves documentation text. It is distinguishable from siblings like search_api or list_api_methods only by the README reference, not by an explicit clause saying what it does.

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?

The three section modes ('TOC' to browse headings, a heading name for one section, '' for everything) implicitly tell the agent how to start exploring, but there is no explicit when-to-use guidance and no mention of when to prefer search_api or get_api_type instead. Usage is discoverable but not stated.

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