Skip to main content
Glama

list_openapi_spec_sources

Fetch available source URLs for OpenAPI specifications, enabling developers to integrate API definitions into their AI-powered IDEs via SushiMCP.

Instructions

This tool lists all available source urls where an OpenAPI spec can be fetched.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The main handler function that implements the logic for the 'list_openapi_spec_sources' tool. It formats and returns a list of available OpenAPI spec sources passed via apiSpecSources.
    export const list_openapi_spec_sources = async (
      extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
      apiSpecSources: Record<string, string>
    ): Promise<CallToolResult> => {
      if (Object.keys(apiSpecSources).length === 0) {
        return {
          content: [
            { type: "text", text: "No OpenAPI specifications configured." },
          ],
        };
      }
      let formatted_specs = "Available OpenAPI specifications:\n";
      for (const name in apiSpecSources) {
        formatted_specs += `- ${name}: ${apiSpecSources[name]}\n`;
      }
      const content: TextContent[] = [
        { type: "text", text: formatted_specs.trim() },
      ];
      return { content };
    };
  • src/index.ts:114-119 (registration)
    Registers the 'list_openapi_spec_sources' tool with the MCP server, providing its description and handler wrapper that passes CLI-provided openApiSpecs.
    server.tool(
      "list_openapi_spec_sources",
      "This tool lists all available source urls where an OpenAPI spec can be fetched.",
      (extra: RequestHandlerExtra<ServerRequest, ServerNotification>) =>
        list_openapi_spec_sources(extra, openApiSpecs)
    );
  • src/index.ts:66-77 (registration)
    Declares the tool capability in the MCP server's capabilities object, including name, description, and annotations.
    list_openapi_spec_sources: {
      name: "list_openapi_spec_sources",
      description:
        "List the source urls where an OpenAPI spec can be fetched.",
      annotations: {
        title: "List OpenAPI spec sources",
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: true,
        openWorldHint: false,
      },
    },
  • src/index.ts:11-14 (registration)
    Imports the list_openapi_spec_sources handler from the tools module.
    list_llms_txt_sources,
    fetch_llms_txt,
    fetch_openapi_spec,
    list_openapi_spec_sources,
  • src/tools/index.ts:5-5 (registration)
    Re-exports the tool handler from its implementation file.
    export * from "./list_openapi_spec_sources.js";
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool lists URLs but does not describe the return format (e.g., list structure, pagination), potential errors, or any operational constraints like rate limits or authentication needs. This leaves significant gaps in understanding how the tool behaves beyond its basic purpose.

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 a single, clear sentence that directly states the tool's function without unnecessary words. It is front-loaded and efficiently communicates the core purpose, 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.

Completeness3/5

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

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is minimally adequate but lacks depth. It covers the basic purpose but does not address behavioral aspects like return format or usage context, which could be helpful for an AI agent. The absence of an output schema means the description should ideally hint at what is returned, but it does not, leaving some contextual gaps.

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?

The tool has 0 parameters, and the schema description coverage is 100%, so no parameter documentation is needed. The description does not add parameter details, which is appropriate here, but it could slightly enhance clarity by noting the absence of inputs. A baseline of 4 is given as it adequately handles the zero-parameter case without redundancy.

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?

The description clearly states the tool's purpose as 'lists all available source urls where an OpenAPI spec can be fetched,' which is a specific verb ('lists') and resource ('source urls'). However, it does not explicitly differentiate from its sibling 'list_llms_txt_sources,' which has a similar structure but for a different resource type, leaving room for slight ambiguity in sibling distinction.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It does not mention its sibling tools (e.g., 'fetch_openapi_spec' for fetching specs or 'list_llms_txt_sources' for listing different sources), nor does it specify any prerequisites or contexts for usage, resulting in minimal guidance.

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

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/maverickg59/sushimcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server