Skip to main content
Glama

Deprecation scan

factreason_deprecation_scan
Read-onlyIdempotent

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

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds crucial behavior: 'Uses metered access when findings exist.' This is a meaningful addition beyond the annotations, as it signals a cost/limit consideration. A small deduction because it doesn't specify what happens to the results or if there's any deprecation-specific data returned.

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?

Three sentences, each earning its place: purpose, usage pattern, and caveat. It's dense but not bloated. Losing a point for front-loading critical info (purpose) well but the metering note feels slightly secondary, though still relevant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only scanning tool with clear annotations and an output schema, the description is quite complete. It explains the tool's niche (deprecation scanning) and distinguishes from siblings. The only minor gap is not explaining what 'metered access' means for the user, but the sibling reference and annotations cover most context needs.

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 the schema already describes 'Optional service filter' and 'Optional endpoint paths to check'. However, the description adds important context about how to use the filters ('Omit filters...', 'pass service to limit one API', 'add endpoints to check selected paths'). The baseline for 100% coverage is 3, and the description earns an extra point for giving semantic meaning to the parameters.

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 ('Scan') and names the resource ('publisher specifications') and subject matter ('deprecated endpoints or parameters, sunset dates, replacement operations'). It clearly differentiates itself from siblings by explicitly pointing to `factreason_api_breaking_changes` for broader 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 when-to-use guidance: 'Omit filters for the catalogue-wide view, pass service to limit one API, and add endpoints to check selected paths.' It also references the alternative sibling tool by name, which addresses the 'vs alternatives' criterion directly.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.6/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: schema lookup, auth playbook, integration brief, breaking changes, package advisory, deprecation scan, component lookup, key creation, payment link creation, discovery, and subscription creation. Descriptions include cross-references that explicitly disambiguate overlapping areas such as api_schema vs. integration_brief vs. auth_playbook.

Naming Consistency4/5

All tools share the factreason_ prefix and snake_case styling, which makes them predictable, but the naming mixes action verbs like create_key, discover_api, and subscribe_spec_changes with noun phrases like api_schema, auth_playbook, and integration_brief. This is mostly consistent but not a strict verb_noun convention across all tools.

Tool Count5/5

11 tools is well within the ideal range for a server with this scope. The count feels intentional: discovery, detail lookups, comparison, validation, key management, billing, and subscription monitoring each have a dedicated tool without unnecessary overlap.

Completeness4/5

The surface covers the main workflow well: discover an API, inspect schemas and auth details, build an integration brief, check version changes and deprecations, handle npm/PyPI packages, and subscribe to spec changes. Minor gaps include no tool to list or delete watches and no direct balance lookup, but these are workarounds.