Skip to main content
Glama

get_plugin_metadata

Retrieve metadata for a specific plugin from the APISIX-MCP server to enable plugin integration via the APISIX Admin API.

Instructions

Get metadata for a specific plugin

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesplugins name

Implementation Reference

  • The registration and inline handler function for the 'get_plugin_metadata' MCP tool. It takes a 'name' argument and calls makeAdminAPIRequest to retrieve metadata from `/plugin_metadata/${args.name}`.
    server.tool("get_plugin_metadata", "Get metadata for a specific plugin", GetPluginMetadataSchema.shape, async (args) => {
      return await makeAdminAPIRequest(`/plugin_metadata/${args.name}`);
    });
  • Zod schema defining the input parameters for the 'get_plugin_metadata' tool, requiring a 'name' string.
    export const GetPluginMetadataSchema = z.object({
      name: z.string().describe("plugins name"),
    });
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Get metadata' but doesn't describe what metadata includes, whether it's a read-only operation, if it requires specific permissions, or what happens if the plugin doesn't exist. For a tool with no annotation coverage, this leaves significant gaps in understanding its 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 purpose without unnecessary words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every word earns its place, with no redundancy or fluff.

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, no output schema, and a simple parameter, the description is incomplete. It doesn't explain what metadata is returned, potential errors, or behavioral traits like idempotency. For a tool in a server with many siblings, more context is needed to ensure proper use without relying on trial and error.

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

Parameters3/5

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

The input schema has 100% description coverage, with the parameter 'name' documented as 'plugins name'. The description doesn't add any semantic details beyond this, such as format examples or constraints. Since schema coverage is high, the baseline score of 3 is appropriate, as the description doesn't compensate but also doesn't detract.

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 verb 'Get' and the resource 'metadata for a specific plugin', making the purpose immediately understandable. It distinguishes from siblings like 'get_all_plugin_names' (which lists names) and 'get_plugin_schema' (which retrieves schema). However, it doesn't explicitly differentiate from 'create_or_update_plugin_metadata', which is a write operation, though the verb 'Get' implies read-only.

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 doesn't mention when to choose this over 'get_all_plugin_names' for listing names or 'get_plugin_schema' for schema details, nor does it specify prerequisites like needing the plugin name first. Usage is implied by the name but not explicitly stated.

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/api7/apisix-mcp'

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