Skip to main content
Glama

Ankr Agent RPC

Move modules in a Sui package

suiGetPackage
Read-only

What a published Move package declares, so a caller can pick what to inspect next. By default this answers with an INDEX: one row per module carrying its name and how many functions and datatypes it holds, capped at 50 rows (raise it with maxModules). Pass module to get that one module in full instead — every function signature and every datatype it declares. The whole package is never returned; the 0x2 framework alone is around 484 KB. This method has no upstream paging, so a truncated index carries no cursor: the way past the cap is maxModules, then module, then suiGetFunction for a single signature. Repeated addresses arrive as $n/@n handles, resolved by the ids and packages tables beside them.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
moduleNo
packageYes
maxModulesNoRows the index lists before it truncates (default 50). Ignored when `module` is given.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnly/openWorld annotations, it discloses real behavioral traits: the whole package is never returned (0x2 framework ~484 KB), there is no upstream paging so a truncated index carries no cursor, and repeated addresses arrive as `$n`/`@n` handles resolved by side tables. These are exactly the operational caveats annotations cannot convey.

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?

Five dense sentences that are largely front-loaded and each carries information (output shape, cap, escalation, size limit, handle resolution). The opening clause 'so a caller can pick what to inspect next' is slightly indirect, but there is no filler.

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?

With no output schema, the description still characterizes the return shape (index rows vs full module contents) and discloses the truncation/no-cursor limitation plus the maxModules-to-module-to-suiGetFunction escalation. For a read-only, three-parameter tool this is complete enough to invoke correctly.

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 only 33%, so the description carries most of the burden: it explains `module` (returns that module in full with every signature and datatype) and `maxModules` (raises the cap, ignored when `module` is given). It also touches handle resolution relevant to `package`, but does not spell out what the `package` value must be (package ID vs object ID), leaving a small gap.

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 precisely what the tool yields: an index of modules with names and function/datatype counts by default, or one module's full function and datatype declarations when `module` is passed. It differentiates from the sibling suiGetFunction ('suiGetFunction for a single signature') so an agent can route without opening a schema.

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?

It gives an explicit escalation path: use the default index, raise `maxModules` past the 50-row cap, pass `module` for full detail, and drop to suiGetFunction for a single signature. This is a clear when-to-use ladder with a named alternative, leaving nothing to inference.

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.