Skip to main content
Glama

Universal Franchise REST Endpoint Runner

fetch_franchise_data
Read-onlyIdempotent

Execute parameterized REST queries against franchisedata.io API endpoints for custom franchise data needs not covered by typed shortcut tools.

Instructions

PAID ($0.002 - $0.005). Execute parameterized REST queries against any franchisedata.io API endpoint with typed arguments. Atomically debits balance per request. Requires 'fc_live_...' API key with sufficient balance. Returns 402 if balance is insufficient. WHEN TO USE: Use ONLY as an escape hatch for arbitrary or custom REST routes not covered by typed shortcut tools. WHEN NOT TO USE: Do not use when a dedicated typed tool exists (e.g. use 'get_fdd_item19' for FDD unit economics, 'detect_tech_stack' for POS hardware, 'get_operator_intelligence' for ownership trees, 'mcdonalds_locations' for McDonald's stores). ALTERNATIVES: Use 'describe_endpoint' first to verify route parameters; use specialized shortcuts for validated schemas.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAPI endpoint route path (e.g. '/api/brands/mcdonalds/locations', '/api/brands/wendys/store/101/status').
paramsNoKey-value map of URL query parameters (e.g. { 'state': 'CA', 'drive_thru': 'true', 'limit': 10 }).
api_keyNoOptional if Authorization header is set. Your 'fc_live_...' API key.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesArray of returned record rows from the database
endpointYesTarget REST endpoint path executed
balance_remaining_usdYesRemaining API credit balance in USD

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.0.1
    • changedInput schema / properties / api_key / description
      Previous value: -"Optional if Authorization header is set."New value: +"Optional if Authorization header is set. Your 'fc_live_...' API key."
    • changedInput schema / properties / params / description
      Previous value: -"Query parameters key-value object (e.g. { city: 'New York', state: 'NY' })"New value: +"Key-value map of URL query parameters (e.g. { 'state': 'CA', 'drive_thru': 'true', 'limit': 10 })."
    • changedInput schema / properties / path / description
      Previous value: -"Endpoint path (e.g. '/api/brands/mcdonalds/locations')"New value: +"API endpoint route path (e.g. '/api/brands/mcdonalds/locations', '/api/brands/wendys/store/101/status')."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "balance_remaining_usd": {
      +      "description": "Remaining API credit balance in USD",
      +      "type": "string"
      +    },
      +    "data": {
      +      "description": "Array of returned record rows from the database",
      +      "type": "array"
      +    },
      +    "endpoint": {
      +      "description": "Target REST endpoint path executed",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "endpoint",
      +    "data",
      +    "balance_remaining_usd"
      +  ],
      +  "type": "object"
      +}
  2. First observedv1.0.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent safety profile, and the description goes well beyond them: per-request pricing ($0.002-$0.005), atomic balance debiting, required 'fc_live_...' key with sufficient balance, and a 402 failure mode. That is exactly the operational context an agent needs before invoking a paid, credential-gated call.

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-loads the paid/cost signal and uses clear labeled sections (WHEN TO USE, WHEN NOT TO USE, ALTERNATIVES) that make it skimmable. It is dense and slightly long, but every sentence earns its place; no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a generic paid REST passthrough with an output schema present, the description covers everything the agent needs: cost, auth requirements, failure mode, and when to prefer typed alternatives. Return-value detail is correctly omitted since the output schema handles it.

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 coverage is 100% with examples in every parameter description ('/api/brands/mcdonalds/locations', {'state':'CA',...}), so the schema carries parameter semantics. The description adds only the general notion of 'typed arguments' and does not extend path/params/api_key meaning beyond the schema, so baseline 3 applies.

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 (Execute) and resource (parameterized REST queries against franchisedata.io endpoints), and explicitly frames itself as a generic escape hatch. The agent can distinguish it from typed shortcut siblings without opening any schema.

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

Usage Guidelines5/5

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

Has explicit WHEN TO USE / WHEN NOT TO USE / ALTERNATIVES sections, naming four concrete sibling tools (get_fdd_item19, detect_tech_stack, get_operator_intelligence, mcdonalds_locations) and the condition that selects each. It even routes the agent to describe_endpoint first to verify routes.

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