Skip to main content
Glama

inspect_structure

Read-onlyIdempotent

Inspect code structure by analyzing classes, methods, and line numbers to prepare for refactoring. Specify file path and depth to control detail level.

Instructions

Get structural information about code (classes, methods, line numbers).

Inspects a file to return information about its structure. Use this to understand the code before applying refactorings.

Args: path: File path to inspect (e.g., 'src/order.py') depth: Level of detail - 'file', 'class', or 'method' (default: 'class')

Returns: TOON-formatted string with structural information.

Example: inspect_structure(path="src/order.py", depth="method")

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
depthNoclass

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already mark it as readOnly and idempotent; description adds that it returns a TOON-formatted string and explains behavior beyond annotations. No contradictions.

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?

Front-loaded with bold summary, followed by clear Args/Returns/Example sections. Every sentence is useful; no unnecessary text.

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?

Given strong annotations and presence of output schema, the description is complete enough for correct agent invocation, covering purpose, parameters, and usage guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description fully explains both parameters: path (example given) and depth (valid values and default), adding essential meaning.

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 clearly states it gets structural information about code (classes, methods, line numbers), distinguishing it from sibling tools like apply_refactoring or preview_refactoring.

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?

Explicitly says 'Use this to understand the code before applying refactorings', providing clear when-to-use context, though not explicitly stating when not to use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/marshally/mcp-refactoring'

If you have feedback or need assistance with the MCP directory API, please join our Discord server