Skip to main content
Glama
outis-co

franchisedata-mcp

by outis-co
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

Track Fleet Openings, Closures, and Relocations

track_brand_changes
Read-onlyIdempotent

Audit recent fleet events including openings, closures, and relocations for a brand to measure footprint growth and detect distress.

Instructions

PAID ($0.003). Audit recent fleet events including permanent closures, new unit openings, and relocations for a brand. Atomically debits $0.003. Requires 'fc_live_...' API key. Returns 402 if balance insufficient. WHEN TO USE: Use for tracking brand footprint expansion, net unit growth velocity, and distress/closure detection. WHEN NOT TO USE: Do not use for real-time daily operating hours (use 'starbucks_store_status'). ALTERNATIVES: Use 'starbucks_store_status' for live store hours; use 'franchise_search_near' for current open units.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
brandYesCanonical brand slug (e.g. 'subway', 'boston-market', 'hardees', 'starbucks')
event_typeNoOptional event filter: 'opening', 'closure', or 'relocation'

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
brandYesBrand slug queried
changesYesList of recent store opening, closure, or relocation events
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 / brand / description
      Previous value: -"Brand slug"New value: +"Canonical brand slug (e.g. 'subway', 'boston-market', 'hardees', 'starbucks')"
    • changedInput schema / properties / event_type / description
      Previous value: -"Optional filter: 'opening', 'closure', 'relocation'"New value: +"Optional event filter: 'opening', 'closure', or 'relocation'"
    • addedInput schema / properties / event_type / enum
      Added value: +[
+  "opening",
+  "closure",
+  "relocation"
+]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "balance_remaining_usd": {
+      "description": "Remaining API credit balance in USD",
+      "type": "string"
+    },
+    "brand": {
+      "description": "Brand slug queried",
+      "type": "string"
+    },
+    "changes": {
+      "description": "List of recent store opening, closure, or relocation events",
+      "items": {
+        "properties": {
+          "address": {
+            "type": "string"
+          },
+          "brand_id": {
+            "type": "string"
+          },
+          "city": {
+            "type": "string"
+          },
+          "effective_date": {
+            "type": "string"
+          },
+          "event_type": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string"
+          },
+          "store_id": {
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "brand",
+    "changes",
+    "balance_remaining_usd"
+  ],
+  "type": "object"
+}
  2. First observedv1.0.0

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations, it discloses cost ($0.003), atomic debit semantics, the required 'fc_live_...' key prefix, and the 402 insufficient-balance failure mode — none of which is inferable from the schema or annotations. This is exactly the side-effect and auth context the structured fields cannot carry. The billing debit is an accounting side effect on the account rather than a mutation of the fleet-event data, so it does not conflict with readOnlyHint=true.

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 paid cost and atomic debit, then the when-to-use routing — good ordering. The WHEN NOT TO USE and ALTERNATIVES sections restate the same 'starbucks_store_status' pointer twice, which is mild redundancy.

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 two-parameter read tool with an output schema, the description covers everything the agent needs: purpose, cost, auth, failure mode, and sibling routing. Return-value shape is delegated to the output schema, so nothing material 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%, so the baseline is 3; the description adds value by glossing 'closure' as 'permanent closures' (distinguishing it from the live-hours sibling) and enumerating the three event types in prose. It does not, however, explain the brand slug format beyond what the schema already states.

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 — auditing recent fleet events (openings, closures, relocations) for a given brand — and the scope is unambiguous. It explicitly differentiates itself from 'starbucks_store_status' (live hours) and 'franchise_search_near' (current open units), so an agent can select it without opening schemas.

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?

Contains explicit WHEN TO USE (footprint expansion, net unit growth velocity, distress/closure detection), WHEN NOT TO USE (real-time daily hours), and named ALTERNATIVES with the conditions that select each. This is a textbook routing block.

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