Skip to main content
Glama

Describe one API operation

omada_describe_api
Read-only

Retrieve full API operation details—parameters, request body, and response schema—for a TP-Link Omada action by operationId or METHOD /path.

Instructions

Full detail for a single operation: path/query parameters, request-body schema and response shape. Accepts an operationId from omada_search_api, or "METHOD /path".

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
operationYesoperationId, or e.g. "PATCH /openapi/v1/{omadacId}/sites/{siteId}/devices/{mac}"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

readOnlyHint=true is consistent with a describe/read tool. Since there is no output schema, the description usefully discloses what the response contains (parameters, request-body schema, response shape), which is behavioral context beyond the annotation.

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?

Two compact sentences, front-loaded with what the tool returns and finished with the accepted input forms. No filler.

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

Completeness4/5

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

With no output schema, the description covers the return content well and fully documents the single input's accepted forms. Minor gap: it doesn't mention error behavior for invalid operationIds/paths, but nothing essential to correct invocation is missing.

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?

Schema coverage is 100% with a single parameter whose description already spells out the operationId or "METHOD /path" format, so the description largely restates the schema. Baseline 3 applies when the schema does the heavy lifting.

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

Purpose5/5

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

States a specific verb+resource: returns full detail for a single API operation, enumerating path/query parameters, request-body schema, and response shape. It explicitly distinguishes itself from the sibling omada_search_api by naming it as the source of the operationId.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear context: use it after omada_search_api, and tells the agent the accepted input forms (operationId or "METHOD /path"). It does not state when NOT to use it or contrast with omada_call, but the workflow placement is unambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.