Skip to main content
Glama

Nolio

Get API endpoint schema

get_endpoint_schema
Read-only

Get the exact request/response schema of one API v2 endpoint (params, body, responses).

Call after search_nolio_api_docs to learn how to shape a nolio_api_read / nolio_api_write call. path may include or omit the /api/v2 prefix (e.g. 'metrics/records/'); method is the HTTP verb. Returns the operation plus the component schemas it references. tool: instead of path, the name of one of this server's tools (e.g. 'get_records'), to read the exact arguments it takes.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_endpoint_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo
toolNo
methodNoget

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / path / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / path / default
      Added value: +null
    • removedInput schema / properties / path / type
      Removed value: -"string"
    • addedInput schema / properties / tool
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
    • removedInput schema / required
      Removed value: -[
      -  "path"
      -]
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered; the description adds real value by stating what comes back ('the operation plus the component schemas it references') and that the /api/v2 prefix is optional on `path`. It doesn't say what happens when the endpoint or tool name isn't found, which is the main behavioral gap for an introspection lookup.

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 core action is stated in the first line, followed by compact usage, path syntax, and the tool-alternative note. Four short blocks, no filler, every sentence carrying distinct information.

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 an output schema present, the return shape needs no elaboration, and the description appropriately focuses on workflow and the path/tool duality. Missing only error behavior (unknown endpoint or tool name) and the default for `method`, which are the remaining unknowns for an agent composing a call.

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 description coverage is 0%, so the description must carry the load — and it largely does: it explains `path` accepts input with or without the /api/v2 prefix (with an example), that `method` is the HTTP verb, and that `tool` is a mutually exclusive alternative to `path` with an example value. It never states that all three parameters are optional/nullable or what the default verb is, so the schema is still needed for the contract.

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?

Opens with a specific verb and resource: 'Get the exact request/response schema of one API v2 endpoint (params, body, responses).' It immediately distinguishes itself from the sibling discovery tools by naming search_nolio_api_docs and the nolio_api_read / nolio_api_write callers it serves.

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 sequencing ('Call after search_nolio_api_docs to learn how to shape a nolio_api_read / nolio_api_write call') and an alternative access mode (use `tool` instead of `path` to inspect this server's own tools). What it lacks is any exclusion — it never says when to skip this and call get_records or another typed sibling directly.

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