Skip to main content
Glama
factreason

factreason

Official
by factreason
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

factreason_subscribe_spec_changes

Idempotent

Create a persistent specification watch for a service. Receive notifications via polling or signed webhook callbacks when specifications change.

Instructions

Create a persistent specification watch for one service; a Bearer API key is required and each key may hold up to 50 watches. Without webhookUrl, read future events from the polling endpoint; with a public HTTP(S) URL, FactReason sends signed POST callbacks after later spec changes. Duplicate or unsafe webhook registrations are rejected. This does not ingest a specification immediately.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
webhookUrlNoOptional public HTTP(S) URL for signed change callbacks; omit to poll
serviceNameYesService name to watch, e.g. "Stripe" or "SendGrid"

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
watchNo
successNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.0.2
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / serviceName / description
      Previous value: -"Service name to watch, e.g. \"Stripe\", \"SendGrid\""New value: +"Service name to watch, e.g. \"Stripe\" or \"SendGrid\""
    • addedInput schema / properties / serviceName / maxLength
      Added value: +200
    • addedInput schema / properties / serviceName / minLength
      Added value: +1
    • changedInput schema / properties / webhookUrl / description
      Previous value: -"Optional HTTP POST webhook URL to receive notifications"New value: +"Optional public HTTP(S) URL for signed change callbacks; omit to poll"
    • addedInput schema / properties / webhookUrl / format
      Added value: +"uri"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "properties": {
+    "error": {
+      "type": "string"
+    },
+    "success": {
+      "type": "boolean"
+    },
+    "watch": {
+      "additionalProperties": true,
+      "properties": {
+        "createdAt": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "serviceName": {
+          "type": "string"
+        },
+        "webhookUrl": {
+          "format": "uri",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. First observedv2.0.1

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, openWorldHint=true, idempotentHint=true), the description exposes critical behavior: authentication requirements, per-key limit, webhook signing, rejection of duplicates/unsafe registrations, and the fact that no immediate ingestion occurs. This is substantial added context that helps an agent understand side effects and prerequisites.

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?

The description is three sentences but packs dense, relevant information: purpose, auth/limits, mode selection, callback signing, rejection rules, and a non-goal. Every sentence earns its place, with no redundant or verbose content.

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?

Given the tool's moderate complexity (two modes, auth, limits), the description covers all essential behavioral aspects: how to register, what happens with/without webhookUrl, and what it does not do. An output schema is present, so not describing return values is acceptable. The description is complete for an agent to select and invoke the tool correctly.

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 input schema already provides full descriptions for both parameters (serviceName and webhookUrl), with 100% coverage. The description adds some contextual detail (e.g., webhook ignores cause polling) but does not materially enhance the parameter understanding beyond the schema.

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?

The description opens with 'Create a persistent specification watch for one service,' which is a specific verb+resource plus clear scope. It distinguishes this tool from siblings like factreason_api_breaking_changes or factreason_api_schema by focusing on subscription/watch functionality.

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?

The description explains two distinct usage modes: omitting webhookUrl to poll, or providing a public URL for signed callbacks. It also gives a key constraint ('Bearer API key required, up to 50 watches') and a non-goal ('does not ingest a specification immediately'), which clarifies when to use the tool, though it does not explicitly name alternative sibling tools.

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