Skip to main content
Glama

LexOpti developer documentation

Read an API operation

get_api_operation
Read-onlyIdempotent

Reads one operation of the LexOpti API: method and path, parameters, request body schema, responses and errors, and its TypeScript SDK example. An operation without French version answers in English, with fallback: true.

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": "get_api_operation"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoLanguage of the documentation: en (default) or fr.en
operationIdYesThe operation, as the API reference names it (checks.create).

Output Schema

NameRequiredDescriptionDefault
urlYes
langYes
pathYes
methodYes
summaryYes
fallbackYes
markdownYes
sdkExampleYes
descriptionYes
operationIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the description isn't carrying the safety burden. It does add real behavior beyond them: the French-version fallback and the 'fallback: true' flag on the response, which an agent could not otherwise anticipate.

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 sentence that front-loads the action, lists the returned content, and appends the fallback caveat last. No redundancy or 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?

For a two-param, output-schema-backed read tool, this covers purpose, returned content, and the one surprising behavior (language fallback). Only the selection guidance vs sibling tools is missing.

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

Parameters4/5

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

Schema coverage is 100% with both params enum'd, so the baseline is 3. The description adds meaning the schema does not: lang=fr may not be honored, and the response will be marked fallback: true in that case, which changes how an agent should interpret the result.

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?

States a specific verb and resource ('Reads one operation of the LexOpti API') and enumerates what the response contains (method/path, parameters, request body schema, responses, errors, SDK example). An agent can tell this is an API-reference lookup rather than a docs page fetch, though the sibling relationship to get_page/search_docs is left implicit.

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 by the resource name; the description never says when to pick this over get_page or search_docs, nor any prerequisite for knowing an operationId. Adequate but guidance is inferred rather than stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources