Skip to main content
Glama
Sign In
patchbay

patchbay

by GodSmasher
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Research an integration

research_api

Plan API integrations backed by Tavily research to return ranked documentation, a connector plan, and a normalized spec with endpoints, auth, and example payloads—without generating code.

Instructions

Plan + Tavily-backed API research only. Returns the connector plan, the ranked documentation sources, and a normalized API spec (endpoints, auth, example payloads). No code is generated and no sandbox is used, so this is cheap and fast.

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

Input Schema

NameRequiredDescriptionDefault
promptYesOne-sentence integration description

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior2/5

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

With no annotations, the description carries the full burden. It usefully discloses the return payload and that no code is generated and no sandbox runs, but says nothing about the external Tavily dependency's failure modes, rate limits, latency or cost behavior, or what happens with an ambiguous prompt — notable gaps for a tool with zero structured safety hints.

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?

Two sentences, front-loaded with the core identity and deliverable list, then the scope-limiting constraint. Every clause carries information; there is no filler.

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 one-parameter tool with no output schema, the description covers what comes back in enough detail (plan, sources, normalized spec with endpoints/auth/payloads) that an agent knows what to expect. Only operational behavior around the external research call is left out.

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?

The single parameter is fully described in the schema ('One-sentence integration description', minLength 4), so the schema already does the work. The description adds no further detail about prompt phrasing, examples, or how specificity affects the output.

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 and resource (API research backed by planning + Tavily) and enumerates the deliverables: connector plan, ranked documentation sources, normalized API spec. It also fences itself off from code-generation tools with 'No code is generated and no sandbox is used,' though it never names the sibling that does that work.

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?

'API research only' plus the no-code/no-sandbox note implies this is the cheap pre-step before build_connector or verify_code, but the agent must infer the ordering itself. There is no explicit 'use this when…, use X instead when…' statement or prerequisite guidance.

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