Skip to main content
Glama
factreason

factreason

Official
by factreason
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

factreason_integration_brief

Read-onlyIdempotent

Compile a concise integration brief for any third-party API, covering base URL, auth scheme, required parameters, request body, and response codes. Provide a service name and optional endpoint to narrow results.

Instructions

Compile one callable third-party API brief: base URL, auth scheme, required parameters and types, request body, and documented response codes. Service is required and endpoint optionally narrows the operation. Set responseFormat="compact" for tokenizer-measured context savings; the backward-compatible default returns the full brief plus compact form. Uses metered access. Prefer factreason_api_schema when exploring multiple endpoints.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
serviceYesThird-party API service, e.g. "Stripe" or "Twilio"
endpointNoOptional path or operation fragment used to select one call
responseFormatNoUse compact for the callable facts only; full preserves the legacy brief responsefull

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
hintNo
briefNo
foundNo
billedNo
compactNo
messageNo
serviceNo
tokenMetricsNo
nearestServicesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.0.4
    • addedInput schema / properties / responseFormat
      Added value: +{
+  "default": "full",
+  "description": "Use compact for the callable facts only; full preserves the legacy brief response",
+  "enum": [
+    "full",
+    "compact"
+  ],
+  "type": "string"
+}
    • removedOutput schema / properties / compact / additionalProperties
      Removed value: -true
    • changedOutput schema / properties / compact / type
      Previous value: -"object"New value: +"string"
    • addedOutput schema / properties / tokenMetrics
      Added value: +{
+  "additionalProperties": false,
+  "properties": {
+    "compactTokens": {
+      "type": "number"
+    },
+    "encoding": {
+      "const": "o200k_base",
+      "type": "string"
+    },
+    "fullTokens": {
+      "type": "number"
+    },
+    "reductionPct": {
+      "type": "number"
+    },
+    "savedTokens": {
+      "type": "number"
+    }
+  },
+  "type": "object"
+}
  2. Changed6 schema fields changedv2.0.2
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / endpoint / description
      Previous value: -"Optional: narrow to endpoints matching this path or operation"New value: +"Optional path or operation fragment used to select one call"
    • addedInput schema / properties / endpoint / minLength
      Added value: +1
    • changedInput schema / properties / service / description
      Previous value: -"Service name, e.g. \"Stripe\", \"Twilio\", \"Cloudflare\""New value: +"Third-party API service, e.g. \"Stripe\" or \"Twilio\""
    • addedInput schema / properties / service / minLength
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "properties": {
+    "billed": {
+      "type": "boolean"
+    },
+    "brief": {
+      "additionalProperties": true,
+      "type": "object"
+    },
+    "compact": {
+      "additionalProperties": true,
+      "type": "object"
+    },
+    "found": {
+      "type": "boolean"
+    },
+    "hint": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    },
+    "nearestServices": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "service": {
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  3. First observedv2.0.1

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is set. The description adds valuable behavior: 'Uses metered access' and explains the full vs. compact response format (backward-compatible default and tokenizer savings), going beyond the annotations. Does not contradict annotations.

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?

Three crisp sentences: purpose and content, key parameter behavior, usage alternative. No filler. Every clause carries distinct information, making it an exemplar of concise structure.

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?

The output schema exists, so return values are covered. The description supplies the essential context: what the brief contains, parameter roles, response format choices, metering, and when to use an alternative. It is complete for this tool's moderate complexity.

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% and each parameter already has a clear description. The description adds extra semantic nuance by explaining that responseFormat='compact' yields 'tokenizer-measured context savings' and notes that service is required while endpoint narrows the operation, enhancing the schema's guidance.

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 begins with 'Compile one callable third-party API brief' – a specific verb and resource. It enumerates the contents (base URL, auth scheme, required params, request body, response codes), which clearly distinguishes it from the sibling 'factreason_api_schema' that explores multiple endpoints.

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?

Explicitly states 'Prefer factreason_api_schema when exploring multiple endpoints', providing a clear when-not scenario and an alternative. Also notes the required service and optional endpoint, and mentions metered access, giving the agent actionable context for when to use this tool.

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