Skip to main content
Glama

itasca_browse_doc

Browse ITASCA documentation by path across command syntax, Python API, FISH intrinsics, and model reference trees to locate specific entries and sections.

Instructions

Browse ITASCA documentation by path, like ls + cat over one documentation tree.

source picks the tree: commands (Itasca command syntax and keywords), python_api (the itasca Python SDK), fish (FISH intrinsic functions: name, signature, which versions have it, whether it is 2D or 3D only), reference (contact/constitutive/joint model properties, range elements, plot items). Each level lists what is below it, so start at the top of a tree when unsure and descend.

Use itasca_query_doc when you only have keywords; its results are paths for this tool.

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": {
      "software": "<software>",
      "source": "<source>"
    },
    "name": "itasca_browse_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoPath inside the selected tree; omit for the top level. - commands: the command as the engine spells it ('ball' lists ball commands, 'ball create' is the full doc, 'ball create radius' one keyword or section; a heading such as 'block contact' or 'structure beam' lists its commands, summary.groups names them) - python_api: dotted from itasca ('itasca.ball', 'itasca.ball.create', 'itasca.ball.Ball.pos') - fish: dotted intrinsic name ('ball' lists the namespace, 'ball.pos' shows its signature plus ball.pos.x/y/z) - reference: 'category item sub' ('contact-models linear', 'range-elements cylinder', 'plot-items zone contour', 'contact-models linearpbond pb_ten' one property or section) A page too large for one response leaves parts out (summary.omitted_sections / summary.compacted); summary.hint gives the path to read them.
sourceYesDocumentation tree: 'commands' (Itasca command syntax), 'python_api' (itasca Python SDK), 'fish' (FISH intrinsic functions), 'reference' (model properties, range elements, plot items).
versionNoDocumentation version. Defaults to 9.0 (the current 9.x release); PFC also has 6.0 and 7.0, FLAC and 3DEC have 7.0; 9.0-only engines (MPoint, MassFlow) always resolve at 9.0. Gates commands, fish and reference entries by availability; python_api is a single 9.8 baseline whose docs carry their own availability notes.9.0
softwareYesITASCA engine to query: 'pfc', 'flac', '3dec', 'mpoint', or 'massflow'. Required — there is no default engine.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.11.1

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does well: the 'ls + cat' framing makes it clear this is a read-only traversal, and each level listing its children is disclosed. It also exposes non-obvious truncation behavior (summary.omitted_sections / summary.compacted / summary.hint) that an agent would otherwise misread as missing data; only an explicit 'no side effects' statement is absent.

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?

Front-loads the verb and the ls+cat analogy, then a per-tree breakdown, then the sibling routing tip — a sensible priority order. The source enumeration partially restates the schema enum, which is mild redundancy but aids scanning.

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 four-parameter, four-tree tool with version gating, the description covers traversal model, per-tree path conventions, truncation handling, and sibling routing. Return values are covered by an output schema, so nothing critical is missing, though version-selection consequences are left entirely to the schema.

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 every parameter including the per-tree path syntax and version gating is already documented in the schema. The description adds the conceptual framing that 'source picks the tree', but no syntax or format detail beyond what the schema already provides, so baseline 3 applies.

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?

States a concrete verb and resource ('Browse ITASCA documentation by path') and immediately grounds it in an analogy ('like ls + cat over one documentation tree') that tells an agent exactly what the operation does. It also enumerates the four trees by content type, which separates it from itasca_query_doc and the execution siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit routing: use this tool when you have a path, use itasca_query_doc 'when you only have keywords', and notes that query results are paths for this tool, forming a clear workflow. It also advises 'start at the top of a tree when unsure and descend', covering the unknown-path case.

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