Skip to main content
Glama

Get ODocs Agent Guide

get-instructions
Read-only

Returns the ODocs.co integration guide as plain text: how patch positions and text anchors are matched, conflict detection with expectedVersion, document lifetime (temporary by default), error codes and rate limits. Relevant when working with an ODocs.co document link without other documentation.

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-instructions"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

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?

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered; the description adds real value beyond that by stating the return format is plain text, listing the guide's contents, and disclosing the important behavioral fact that documents are temporary by default.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with what is returned before the relevance condition. The topic list is dense but each item earns its place by telling the agent what questions the guide answers; slight verbosity in the enumeration is acceptable.

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 zero-parameter, read-only fetch of a static guide with no output schema, the description covers what comes back, in what format, and when to call it. Only marginal details (guide length, whether it is static or version-dependent) are absent.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate; the baseline for a no-param tool applies and no parameter-related gaps exist.

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 names a specific verb and resource ('Returns the ODocs.co integration guide as plain text') and enumerates the exact topics contained (patch positions, text anchors, conflict detection with expectedVersion, document lifetime, error codes, rate limits), which clearly separates it from document-reading siblings like get-document or get-version.

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 a clear triggering condition: use it when working with an ODocs.co document link and no other documentation is available. That is a genuine when-to-use cue, though it stops short of explicitly ruling out or naming alternative tools for adjacent needs.

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