Skip to main content
Glama

api_search

Read-only

Search a running app's API before writing code and look up exact Blender names to retrieve parameters and enum values.

Instructions

Searches the app's API from the running version; use it before writing code. Blender: bpy.ops and bpy.types, open add-ons included. An exact name ('bpy.ops.mesh.primitive_cube_add') dumps the parameters and enum values.

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

Input Schema

NameRequiredDescriptionDefault
appYes
queryYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/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, and the description is consistent with a local, side-effect-free lookup. It adds real context beyond annotations: results reflect the running version and include open add-ons, and an exact name dumps parameters and enum values. It stops short of describing result shape, pagination, or how many results a partial query returns.

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?

Dense and front-loaded, with the action first and the lookup behavior last, which is appropriate. The terse "Blender:" fragment reads like a note dropped mid-description and slightly hurts flow, but there is little wasted text.

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?

With an output schema present, return-value explanation isn't required, and the description covers purpose, timing, and the two query modes. The only gap that matters for correct invocation is the undocumented set of valid 'app' strings.

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 coverage is 0% and both parameters are undocumented in the schema, so the description must compensate. It does clarify query semantics substantially (partial search vs. exact dotted name yielding params/enums) and hints that 'app' selects the host (Blender), but it never enumerates valid app values.

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: searches the app's API as exposed by the running version, not static docs. The added scope details (bpy.ops/bpy.types, open add-ons included) make it clearly distinct from siblings like asset_search or run.

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

Usage Guidelines4/5

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

"Use it before writing code" gives an explicit when-to-use signal, and the exact-name sentence describes a second usage mode (lookup vs. discovery). No when-not-to-use or named alternative is given, keeping it at 4 rather than 5.

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