Skip to main content
Glama

How to build an app on UnblockingAPI

get_build_guide
Read-onlyIdempotent

Read this before writing code that uses UnblockingAPI - an app, script, scheduled job or backend that fetches web pages (a rank tracker, a listings aggregator, a price monitor, …). Returns the REST API reference for calling it with plain HTTP (no SDK), how to keep the key server-side on platforms like Lovable, Replit and Next.js, how to use templates, and complete recipes. Free. Start with topic 'api', then the recipe that fits.

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

Input Schema

NameRequiredDescriptionDefault
topicYes'api': the REST API for apps: request, response, errors, timeouts, keeping the key server-side. 'fetch-tuning': getting complete pages: scrolling, waiting for content, consent walls, locations. 'templates': finding and calling templates for JSON, their output shapes, building your own. 'rank-tracker': recipe: a Google rank tracker for keywords and domains. 'listings-aggregator': recipe: one page that aggregates listings (e.g. properties) from several sites. 'price-monitor': recipe: watch product prices and alert on changes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower. The description adds useful context beyond them: it is free, and it enumerates the returned material (HTTP reference, server-side key handling on Lovable/Replit/Next.js, templates, recipes). No rate limits or pagination notes, but those are minor for a docs tool.

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?

Front-loaded with the directive 'Read this before writing code', followed by scope, return contents, cost, and a starting recommendation — every clause carries information. Dense but not padded.

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 compensates by describing what the guide returns and the topic options. For a single-param read-only docs tool this is close to complete; only explicit sibling routing against find_templates is missing.

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 100% with all enum values documented, so the baseline is 3. The description adds sequencing semantics the schema lacks ('start with api, then the recipe that fits'), giving the agent guidance on how to order calls with the topic argument.

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+resource: it returns the REST API reference and recipes for building on UnblockingAPI, with concrete examples (rank tracker, listings aggregator). An agent can tell it apart from unblock_fetch (which fetches pages), though its overlap with find_templates is only loosely handled by the 'templates' topic.

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?

Explicit timing is given ('Read this before writing code that uses UnblockingAPI') plus a recommended sequence ('Start with topic \'api\', then the recipe that fits'). It does not explicitly say when to prefer this over the sibling find_templates tool, so it stops short of full alternative routing.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.