Skip to main content
Glama
factreason

factreason

Official
by factreason
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

factreason_auth_playbook

Read-onlyIdempotent

Retrieve a structured auth playbook for any third-party API: schemes, scopes, rate-limit headers, and error codes. Marks undocumented details as unstated, not guessed.

Instructions

Get publisher-declared authentication schemes, scopes, rate-limit headers, and error codes for one third-party API. Returns a structured playbook or nearest service suggestions, and marks undocumented details as unstated rather than guessing. Uses metered access. Prefer factreason_integration_brief when assembling a complete API call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
serviceYesThird-party API service, e.g. "Stripe", "Twilio", or "Cloudflare"

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
foundNo
compactNo
messageNo
playbookNo
nearestServicesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.0.2
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / service / description
      Previous value: -"Service name, e.g. \"Stripe\", \"Twilio\", \"Cloudflare\""New value: +"Third-party API service, e.g. \"Stripe\", \"Twilio\", or \"Cloudflare\""
    • addedInput schema / properties / service / minLength
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": true,
+  "properties": {
+    "compact": {
+      "additionalProperties": true,
+      "type": "object"
+    },
+    "found": {
+      "type": "boolean"
+    },
+    "message": {
+      "type": "string"
+    },
+    "nearestServices": {
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "playbook": {
+      "additionalProperties": true,
+      "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?

Annotations already declare readOnlyHint and idempotentHint, but the description adds valuable behavioral details: 'Uses metered access' warns of cost/rate implications, and 'marks undocumented details as unstated rather than guessing' communicates honest fallback behavior. It also mentions returning 'nearest service suggestions' when the exact service is not found, which is useful context beyond the 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?

The description is three sentences long, each serving a purpose: the first states the core function, the second explains the return behavior, and the third gives alternative guidance. It is front-loaded and free of unnecessary detail, making it highly concise and well-structured.

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 simplicity (one parameter), the presence of an output schema, clear annotations, and explicit alternative guidance, the description provides sufficient context for an agent to select and invoke the tool correctly. It covers purpose, behavior, usage, and fallbacks without being overly verbose.

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 has 100% description coverage for the single parameter 'service', including examples. The description does not add additional parameter meaning beyond what the schema already provides, so a baseline score of 3 is appropriate.

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 clearly states the tool's purpose with a specific verb and resource: 'Get publisher-declared authentication schemes, scopes, rate-limit headers, and error codes for one third-party API.' It differentiates from the sibling tool factreason_integration_brief by noting that the latter is preferred for assembling complete API calls, making the scope explicit.

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 provides clear context for when to use this tool (when authentication details are needed) and explicitly names an alternative (factreason_integration_brief for complete API calls). However, it does not exhaustively contrast with other sibling tools like factreason_api_schema or factreason_discover_api, leaving some ambiguity for edge cases.

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