omada-mcp

Describe an Omada API operation

omada_describe_operation

Read-only

Retrieves full call details for an Omada API operation—method, path, parameters, request/response schemas, permissions, and error codes—so you can invoke it correctly.

Instructions

Show everything needed to call one operation: method, path, path/query parameters, request body JSON schema, required permissions and error codes. Optionally the response schema.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "operationId": "<operationId>"
    },
    "name": "omada_describe_operation"
  }
}

Input Schema

Name	Required	Description	Default
`operationId`	Yes	From omada_search_operations
`includeResponseSchema`	No	Also show the schema of the result

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Nov 7, 2026

TDQS

A3.8/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is known. The description adds real value by disclosing the exact contents of the result — parameters, body schema, required permissions, and error codes — which matters because no output schema exists to convey this.

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?

A single front-loaded sentence with a tight enumeration of returned fields and one closing clause for the optional response schema. No filler or redundancy.

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 must describe return contents, which it does thoroughly for a read-only introspection tool. The minor gap is that it never states how to obtain a valid operationId or how this differs from omada_get_schema.

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%, so both parameters are already documented, and the description's phrase 'Optionally the response schema' only loosely reinforces includeResponseSchema. The one genuinely important detail — that operationId comes from omada_search_operations — lives in the schema, not the description. Baseline 3 applies.

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 uses a specific verb and resource ('Show everything needed to call one operation') and enumerates exactly what is returned: method, path, parameters, request body schema, permissions, and error codes. This clearly separates it from execution tools like omada_call_operation, but it never names the sibling omada_search_operations or omada_get_schema to draw a hard boundary.

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

Usage Guidelines3/5

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

Usage is only implied: 'everything needed to call one operation' hints that this is a pre-call discovery step before omada_call_operation. There is no explicit when-to-use, no exclusion of alternatives such as omada_get_schema, and no statement of prerequisites.

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

Deploy Server