Skip to main content
Glama

api_search

Search Resolve's scripting API with case-insensitive regex for classes, methods, constants, settings keys; returns signatures, docs, owning class. Set readme=true to search README notes.

Instructions

Search Resolve's scripting API reference (regex, case-insensitive) for classes, methods, constants and settings keys — returns matching signatures with docs and owning class. readme=true searches the README notes instead.

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

Input Schema

NameRequiredDescriptionDefault
readmeNo
patternYes
max_resultsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose useful behavior: matching is regex-based and case-insensitive, and results include full signatures plus docs and owning class. It omits important traits such as what happens on no match, whether results are truncated, and any cost/latency characteristics of a broad regex.

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?

A single dense sentence, front-loaded with the verb and corpus, with the readme branch appended. There is no filler, though the mid-sentence parenthetical and the em-dash clause make it slightly harder to parse than a two-sentence split would.

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?

No output schema exists, and the description still explains the shape of results (signatures with docs and owning class), which is the critical missing piece. Remaining gaps are minor but real: truncation/limit behavior for max_results and empty-result behavior are unaddressed.

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 0%, so the description must compensate. It adds real meaning for 'pattern' (regex, case-insensitive) and 'readme' (searches README notes instead), but 'max_results' is never mentioned despite having a default of 60 and implying truncation semantics.

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?

States a specific verb and resource: search Resolve's scripting API reference for classes, methods, constants and settings keys. It also names the return payload (matching signatures with docs and owning class), so an agent knows exactly what this tool produces without scanning siblings.

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 only implied — the agent must infer this is the tool to call when it needs API/signature lookup. The one routing hint given is internal to the tool (readme=true switches to README notes), not guidance about when to prefer or avoid this tool versus alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.