Skip to main content
Glama
goya02-ops

anylogic-docs

by goya02-ops

anylogic_read

Reads a specific AnyLogic documentation page or section by path to retrieve guide or API content, optionally narrowing results to a heading.

Instructions

Lee una página o una sección concreta del corpus.

Args: path: ruta relativa devuelta por anylogic_search, p.ej. "guide/anylogic/3d/3d-object.md" o "api/com/anylogic/engine/Agent.md". heading: si se indica, devuelve sólo esa sección (coincidencia parcial). max_chars: recorte máximo del resultado.

Input Schema

NameRequiredDescriptionDefault
pathYes
headingNo
max_charsNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden. 'Lee' conveys a read-only operation, and it usefully discloses heading partial-matching and max_chars truncation behavior. It does not mention what happens on an unknown path (error vs empty) or result pagination, which for an unannotated tool is a gap.

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?

One-sentence purpose is front-loaded, followed by a compact per-argument list. No filler. The Args block is standard and each line earns its place.

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?

An output schema exists, so return-value explanation is unnecessary, and all three parameters are documented in prose. For a simple read tool this is nearly complete; only edge-case behavior (missing path, heading not found) is left unstated.

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 0%, so the description must compensate, and it does document all three parameters with meaning beyond the schema: path format with concrete examples, heading as a partial-match section filter, and max_chars as an output truncation cap. It omits the max_chars default (12000) and valid ranges, keeping it from a 5.

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+resource: 'Lee una página o una sección concreta del corpus.' Clear what it does and that it operates on a path within the corpus. It distinguishes itself implicitly from anylogic_search by referencing the paths that search returns, but never names siblings explicitly.

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?

'path: ruta relativa devuelta por anylogic_search' implies the workflow (search first, then read). However, there is no explicit 'use this when' guidance and no differentiation from anylogic_api, anylogic_examples, or anylogic_toc for similar content retrieval.

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