Skip to main content
Glama

list_services

List configured Swagger services and their local cache status for a workspace without contacting remote servers.

Instructions

List configured Swagger services and local cache state. This never fetches remote documents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceYesAbsolute path to the business project that owns .swagger-mcp.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose one meaningful behavioral trait: it performs no remote fetch, so results reflect local state only. It stops short of stating whether it touches disk/network at all, permission requirements, or any side effects.

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?

Two short sentences, front-loaded with what is listed and followed by the key constraint. No filler or redundancy.

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 one-parameter read tool with no output schema and no annotations, the description conveys what is returned (services and cache state) and the crucial no-fetch constraint. It is largely complete, though it could note prerequisites such as the workspace needing prior initialization.

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?

Schema description coverage is 100% for the single workspace parameter, so the schema already documents its meaning fully. The description adds no additional parameter semantics beyond what the schema provides, making 3 the correct baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: listing configured Swagger services plus local cache state. The clause 'never fetches remote documents' implicitly distinguishes it from the refresh_service / refresh_all_services siblings, though it does not name them directly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by the read-only listing framing and the no-fetch boundary, which suggests it is the tool to call when inspecting configuration rather than updating it. However, no explicit when-to-use conditions or named alternatives are given.

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