Skip to main content
Glama

search-api-operations

Search for API operations across OpenAPI specifications to find endpoints, methods, and parameters for development workflows.

Instructions

Search for operations across specifications

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
specIdNo

Implementation Reference

  • The handler function for the 'search-api-operations' tool. It searches for operations using specExplorer.searchOperations and returns YAML-formatted results.
    async (args, extra) => {
      try {
        this.logger.debug('Searching API operations', { query: args.query, specId: args.specId });
        const operations = await this.specExplorer.searchOperations(
          args.query,
          args.specId
        );
        return {
          content: [
            { type: "text", text: stringify({ operations }, { indent: 2 }) },
          ],
        };
      } catch (error) {
        this.logger.error('Failed to search API operations', { error, query: args.query });
        throw error;
      }
    }
  • Input schema for the tool using Zod: query (required string), specId (optional string).
    {
      query: z.string(),
      specId: z.string().optional(),
    },
  • Registration of the 'search-api-operations' tool on the MCP server with name, description, schema, and handler.
    server.tool(
      "search-api-operations",
      "Search for operations across specifications",
      {
        query: z.string(),
        specId: z.string().optional(),
      },
      async (args, extra) => {
        try {
          this.logger.debug('Searching API operations', { query: args.query, specId: args.specId });
          const operations = await this.specExplorer.searchOperations(
            args.query,
            args.specId
          );
          return {
            content: [
              { type: "text", text: stringify({ operations }, { indent: 2 }) },
            ],
          };
        } catch (error) {
          this.logger.error('Failed to search API operations', { error, query: args.query });
          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 but offers minimal insight. It doesn't describe what 'search' entails (e.g., fuzzy matching, exact terms), the format of results, pagination, rate limits, or authentication needs. This leaves critical behavioral traits unspecified for a search tool.

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, efficient sentence with zero waste. It's appropriately sized and front-loaded, directly stating the tool's purpose without unnecessary elaboration, making it easy to parse quickly.

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 of a search tool with 2 parameters, 0% schema coverage, no annotations, and no output schema, the description is incomplete. It lacks details on behavior, parameters, results, and differentiation from siblings, failing to provide enough context for effective tool selection and invocation.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate but adds no parameter details. It doesn't explain what 'query' should contain (e.g., keywords, operation names) or what 'specId' refers to (e.g., API specification identifiers), leaving both parameters semantically undefined beyond their types.

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 'Search for operations across specifications' clearly states the action (search) and target (operations), but it's vague about scope and lacks differentiation from sibling tools like 'search-api-schemas' or 'get-api-catalog'. It doesn't specify what constitutes an 'operation' or how this search differs from other search tools.

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?

No guidance is provided on when to use this tool versus alternatives. The description doesn't mention prerequisites, context, or exclusions, and it fails to differentiate from sibling tools like 'search-api-schemas' or 'load-api-operation-by-operationId', leaving the agent with no usage context.

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