Skip to main content
Glama
progress-all

ACOMO MCP Server

by progress-all

Describe API

describe_api

Retrieve detailed information about API operations (paths, methods, summaries) in ACOMO services using the specified operation ID for clarity and integration support.

Instructions

operationIdの詳細(paths/method/要約/原文)を返す

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationIdYes

Implementation Reference

  • The core handler function for the "describe_api" tool. It retrieves the operation using findOperationById, handles missing operations, constructs an example complete URL from config baseUrl and path, and returns a formatted JSON response with operation details and raw spec.
    async ({ operationId }: { operationId: string }) => {
      const op = await findOperationById(operationId);
      if (!op)
        return {
          content: [
            { type: "text", text: `Unknown operationId: ${operationId}` },
          ],
          isError: true,
        };
      const cfg = getConfig();
      const base = cfg.baseUrl.replace(/\/$/, "");
      const completeUrl = `${base}${op.path.startsWith("/") ? "" : "/"}${op.path}`;
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(
              {
                operationId: op.operationId,
                method: op.method,
                path: op.path,
                summary: op.summary,
                baseUrlExample: base,
                completeUrl,
                raw: op.raw,
              },
              null,
              2
            ),
          },
        ],
      };
    }
  • Input schema definition using Zod, specifying 'operationId' as a required string parameter.
    inputSchema: { operationId: z.string() },
  • src/server.ts:48-88 (registration)
    Registration of the "describe_api" MCP tool via server.registerTool, including title, description, schema, and inline handler.
    server.registerTool(
      "describe_api",
      {
        title: "Describe API",
        description: "operationIdの詳細(paths/method/要約/原文)を返す",
        inputSchema: { operationId: z.string() },
      },
      async ({ operationId }: { operationId: string }) => {
        const op = await findOperationById(operationId);
        if (!op)
          return {
            content: [
              { type: "text", text: `Unknown operationId: ${operationId}` },
            ],
            isError: true,
          };
        const cfg = getConfig();
        const base = cfg.baseUrl.replace(/\/$/, "");
        const completeUrl = `${base}${op.path.startsWith("/") ? "" : "/"}${op.path}`;
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify(
                {
                  operationId: op.operationId,
                  method: op.method,
                  path: op.path,
                  summary: op.summary,
                  baseUrlExample: base,
                  completeUrl,
                  raw: op.raw,
                },
                null,
                2
              ),
            },
          ],
        };
      }
    );
  • Supporting helper function that scans the OpenAPI specification to find and return the operation matching the given operationId, including raw operation object. Used directly in the describe_api handler.
    export async function findOperationById(
      operationId: string
    ): Promise<(Operation & { raw: any }) | null> {
      const spec = await loadOpenApi();
      for (const [path, methods] of Object.entries(spec.paths ?? {})) {
        for (const [method, op] of Object.entries(methods ?? {})) {
          if ((op as any)?.operationId === operationId) {
            return {
              operationId,
              method: method.toUpperCase(),
              path,
              summary: (op as any)?.summary,
              raw: op,
            };
          }
        }
      }
      return null;
    }
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 returns details but doesn't describe error handling, rate limits, authentication needs, or what happens if the operationId is invalid. This leaves significant gaps for a tool with no structured safety hints.

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 front-loaded and appropriately sized for the tool's apparent complexity, 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 no annotations, 0% schema coverage, and no output schema, the description is incomplete. It doesn't explain return values, error cases, or behavioral traits needed for a tool that fetches API details, leaving the agent with insufficient context.

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 for undocumented parameters. It mentions 'operationId' but doesn't explain its format, source, or constraints beyond what's implied. This adds minimal semantic value over the bare schema.

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 states the tool returns details about an operationId, including paths, methods, summaries, and original text, which gives a vague purpose. It specifies the resource (operationId details) but lacks a clear verb beyond 'returns' and doesn't differentiate from siblings like 'describe_component' or 'list_apis'.

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. It doesn't mention prerequisites, context for selecting it over siblings like 'list_apis' or 'describe_component', or any exclusions, leaving usage unclear.

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/progress-all/acomo-mcp-server'

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