Skip to main content
Glama

itasca_browse_python_api

Browse Itasca Python SDK documentation by dot-separated API path for a chosen engine, from root modules to specific functions and methods. Use it to quickly locate SDK references and usage details.

Instructions

Browse Itasca Python SDK documentation by path (like glob + cat).

Input Schema

NameRequiredDescriptionDefault
apiNoItasca Python API path to browse (dot-separated, starting from itasca). Examples: - None or '': Root overview - all modules and objects - 'itasca': Core module functions (command, cycle, gravity, etc.) - 'itasca.ball': Ball module functions (create, find, list, etc.) - 'itasca.ball.create': Specific function documentation - 'itasca.ball.Ball': Ball object method groups - 'itasca.ball.Ball.pos': Specific method documentation - 'itasca.wall.facet': Nested submodule - 'itasca.wall.facet.Facet': Facet object in wall.facet module
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.5.1

TDQS

A3.5/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; 'browse' and the glob+cat analogy do imply a read-only, non-destructive operation that returns documentation text. However, it says nothing about output size, pagination, or what happens when a path is invalid, leaving real behavioral gaps.

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?

A single front-loaded sentence with the verb, resource, and access model; nothing wasted.

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

Completeness3/5

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

An output schema exists and both parameters are fully documented, so the basics are covered. But for a documentation-browsing tool sitting among several overlapping siblings, the description lacks the routing detail needed to call it confidently instead of itasca_query_python_api or itasca_browse_reference.

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% and the api parameter already carries exhaustive path examples, so the schema does the heavy lifting. The description's 'by path' phrase reinforces the key concept but adds no syntax or edge-case meaning beyond the schema.

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 (browse) and resource (Itasca Python SDK documentation) with a path-based access pattern. It implicitly separates itself from itasca_browse_commands and itasca_browse_reference via 'Python SDK', but never names those 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?

The '(like glob + cat)' analogy implies navigation then retrieval, but there is no explicit when-to-use guidance versus itasca_query_python_api, itasca_browse_reference, or itasca_browse_commands. Usage must be inferred from the tool name and analogy.

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