Skip to main content
Glama

myIO Documentation

Read myIO doc section

myio_read
Read-onlyIdempotent

Full text (Markdown) of one section of the myIO documentation, by its id from myio_search or myio_toc. Long sections come in parts; the response names the next part.

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": {
      "id": "<id>"
    },
    "name": "myio_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesSection id, e.g. "manual:thermostat" or "api:4-1"
partNoPart number for long sections (default 1)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already establish a safe, idempotent read operation, and the description adds useful behavior beyond them: the return is Markdown full text and long sections are paginated into parts with the response naming the next part. This gives an agent practical context for handling long results.

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 two tight sentences with no wasted wording. The core action and return type are front-loaded, followed by the pagination caveat.

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

Completeness5/5

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

For a simple two-parameter read tool with rich annotations and a fully documented schema, this is complete. It explains what is returned, how the id is sourced, and how long sections are handled, so no essential calling information 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 description coverage is 100%, so both the id and part parameters are already documented. The description adds that the id comes from myio_search or myio_toc and that parts relate to long sections, but it does not substantially extend the schema's parameter meaning.

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?

The description states a specific verb and resource: read the full Markdown text of one myIO documentation section by id. It also distinguishes this from myio_search and myio_toc by framing those as places to obtain the id, making the scope clear.

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?

It gives clear usage context by saying the id comes from myio_search or myio_toc, implying this tool is used after locating a section rather than for discovery. It does not explicitly state when not to use the tool, but the intended workflow is clear.

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