Skip to main content
Glama

factreason_deprecation_scan

Read-onlyIdempotent

Scan API specifications to identify deprecated endpoints, parameters, sunset dates, and replacement operations. Filter by service or endpoint paths to focus on specific APIs.

Instructions

Scan publisher specifications for deprecated endpoints or parameters, sunset dates, and replacement operations. Omit filters for the catalogue-wide view, pass service to limit one API, and add endpoints to check selected paths. Uses metered access when findings exist. Use factreason_api_breaking_changes for broader version-to-version changes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
serviceNoOptional service filter, e.g. "Stripe" or "Twilio"
endpointsNoOptional endpoint paths to check within the selected service

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
countNo
foundNo
messageNo
resultsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.0.2
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / endpoints / description
      Previous value: -"Optional list of endpoint paths to check"New value: +"Optional endpoint paths to check within the selected service"
    • addedInput schema / properties / endpoints / items / minLength
      Added value: +1
    • addedInput schema / properties / endpoints / minItems
      Added value: +1
    • changedInput schema / properties / service / description
      Previous value: -"Optional: filter by service name, e.g. \"Stripe\", \"Twilio\""New value: +"Optional service filter, e.g. \"Stripe\" or \"Twilio\""
    • addedInput schema / properties / service / minLength
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "count": {
      +      "type": "number"
      +    },
      +    "found": {
      +      "type": "boolean"
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "results": {
      +      "items": {
      +        "additionalProperties": true,
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observedv2.0.1

TDQS

A5/5.0
Behavior5/5

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

Beyond the readOnlyHint/idempotentHint annotations, it discloses a non-obvious behavioral trait: 'Uses metered access when findings exist.' This adds cost/rate context not present in 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?

Three concise sentences front-load the core purpose, then parameter usage, then the alternative tool. Every sentence earns its place with no repetition or fluff.

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 an output schema exists and this is an optional-filter scan tool, the description fully covers scope, filtering behavior, cost implications, and an alternative. No critical gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although schema coverage is 100%, the description adds meaningful semantics: omitting filters yields catalogue-wide view, passing service limits to one API, and adding endpoints checks selected paths. This goes beyond the schema's simple optional descriptions.

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 uses a specific verb+resource ('Scan publisher specifications for deprecated endpoints or parameters, sunset dates, and replacement operations') and explicitly distinguishes from a sibling tool ('Use factreason_api_breaking_changes for broader version-to-version changes').

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?

It provides clear parameter usage guidance ('Omit filters for the catalogue-wide view, pass service to limit one API, and add endpoints to check selected paths') and names an explicit alternative tool for related but different needs.

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