Skip to main content
Glama
progress-all

ACOMO MCP Server

by progress-all

Describe component

describe_component

Retrieve detailed JSON Schema for a specified schema name within the ACOMO MCP Server. Facilitates API exploration and schema inspection for backend services.

Instructions

指定schema名の詳細(JSON Schema)を返す

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes

Implementation Reference

  • Handler function that executes the describe_component tool logic: calls getComponentSchema and returns the JSON Schema or an error message.
    async ({ name }: { name: string }) => {
      const schema = await getComponentSchema(name);
      if (!schema)
        return {
          content: [{ type: "text", text: `Unknown component: ${name}` }],
          isError: true,
        };
      return {
        content: [
          { type: "text", text: JSON.stringify(schema, null, 2) },
        ],
      };
    }
  • Tool metadata including title, description, and input schema requiring a 'name' string parameter using Zod.
    {
      title: "Describe component",
      description: "指定schema名の詳細(JSON Schema)を返す",
      inputSchema: { name: z.string() },
    },
  • src/server.ts:261-281 (registration)
    Registration of the 'describe_component' tool using McpServer.registerTool with schema and handler.
    server.registerTool(
      "describe_component",
      {
        title: "Describe component",
        description: "指定schema名の詳細(JSON Schema)を返す",
        inputSchema: { name: z.string() },
      },
      async ({ name }: { name: string }) => {
        const schema = await getComponentSchema(name);
        if (!schema)
          return {
            content: [{ type: "text", text: `Unknown component: ${name}` }],
            isError: true,
          };
        return {
          content: [
            { type: "text", text: JSON.stringify(schema, null, 2) },
          ],
        };
      }
    );
  • Helper function that loads the OpenAPI spec and retrieves the schema for the given component name.
    export async function getComponentSchema(name: string): Promise<any | null> {
      const spec = await loadOpenApi();
      return spec.components?.schemas?.[name] ?? 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 mentions returning JSON Schema details but fails to describe error handling, rate limits, authentication needs, or what happens if the schema name is invalid. This leaves significant gaps in understanding the tool's behavior.

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 that directly states the tool's function without unnecessary words. It is appropriately sized and front-loaded, 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 tool has no annotations, no output schema, and low schema description coverage, the description is insufficient. It doesn't explain return values, error cases, or usage context relative to siblings, making it incomplete for effective agent use.

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?

The input schema has 1 parameter with 0% description coverage, and the description does not add any semantic details about the 'name' parameter. It doesn't explain what the name refers to, its format, or examples, failing to compensate for the lack of schema documentation.

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 detailed JSON Schema for a specified schema name, which clarifies the verb ('return') and resource ('detailed JSON Schema'). However, it doesn't differentiate from sibling tools like 'describe_api' or 'list_components', leaving ambiguity about when to use each. The purpose is clear but lacks 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 such as 'describe_api' or 'list_components'. There are no explicit instructions on context, prerequisites, or exclusions, leaving the agent to infer usage based solely on the tool name and description.

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