Skip to main content
Glama

refresh-api-catalog

Update the API catalog to reflect current OpenAPI specifications, ensuring AI-powered development tools access accurate API documentation.

Instructions

Refresh the API catalog

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Inline handler for the refresh-api-catalog tool. Logs the action, calls specExplorer.refresh() to refresh the API catalog, and returns a success message. Errors are logged and rethrown.
    server.tool("refresh-api-catalog", "Refresh the API catalog", async () => {
      try {
        this.logger.info('Refreshing API catalog');
        await this.specExplorer.refresh();
        this.logger.info('API catalog refreshed successfully');
        return {
          content: [{ type: "text", text: "API catalog refreshed" }],
        };
      } catch (error) {
        this.logger.error('Failed to refresh API catalog', { error });
        throw error;
      }
    });
  • Registers the refresh-api-catalog tool on the MCP server with no input schema and the inline handler function.
    server.tool("refresh-api-catalog", "Refresh the API catalog", async () => {
      try {
        this.logger.info('Refreshing API catalog');
        await this.specExplorer.refresh();
        this.logger.info('API catalog refreshed successfully');
        return {
          content: [{ type: "text", text: "API catalog refreshed" }],
        };
      } catch (error) {
        this.logger.error('Failed to refresh API catalog', { error });
        throw error;
      }
    });
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. 'Refresh' implies a mutation or update operation, but the description doesn't specify whether this is a read-only refresh, requires permissions, has side effects, or involves rate limits. It lacks details on what 'refresh' does beyond the basic action.

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 extremely concise with a single sentence ('Refresh the API catalog'), which is front-loaded and wastes no words. For a tool with no parameters, this brevity is appropriate and efficient.

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

Completeness2/5

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

Given the complexity implied by 'refresh' (likely a mutation) and no annotations or output schema, the description is incomplete. It doesn't explain what happens during refresh, the response format, or error conditions, leaving significant gaps for the agent to understand the tool's behavior fully.

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 schema description coverage is 100%, so no parameter documentation is needed. The description doesn't add parameter semantics, but with no parameters, this is acceptable, warranting a baseline score of 4 for adequate coverage in this context.

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

Purpose3/5

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

The description 'Refresh the API catalog' states a clear action ('refresh') on a specific resource ('API catalog'), which is better than a tautology. However, it doesn't differentiate from sibling tools like 'get-api-catalog' or explain what 'refresh' entails operationally, leaving the purpose somewhat vague.

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 like 'get-api-catalog' or other siblings. There's no mention of prerequisites, frequency, or context for refreshing, so the agent must infer usage without explicit direction.

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

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/ReAPI-com/mcp-openapi'

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