Skip to main content
Glama

coding_explain_code

Explains how code works, why it's structured that way, and its inputs/outputs. Adjusts depth for engineer, junior, product, or executive audiences.

Instructions

Explain how a piece of code works, why it's structured this way, and what its inputs/outputs are. Tunes depth to the requested audience. Args: message: Free-text objective for the action. path (required): File path or symbol to explain. audience: One of: engineer, junior, product, executive.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageNo
pathNo
audienceNoengineer

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations, the description carries the burden. It mentions audience tuning but lacks details on side effects, permissions, or limitations. No contradiction with annotations.

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?

Two concise sentences plus a clear arg list. Every sentence adds value; no redundancy or fluff.

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?

Given the presence of an output schema, the description adequately covers purpose and audience adaptation. It could mention the output format, but the schema handles that.

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?

The description explains each parameter: message as free-text objective, path as required file path (despite schema showing default null), and audience with specific enum values. Adds meaningful context beyond the schema, though the 'required' claim slightly misaligns.

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 the verb 'explain' and the resource 'piece of code', with details on structure and input/output. It distinguishes from siblings like coding_read_code by focusing on explanation and audience tuning.

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 description implies usage for code explanation with audience adaptation, but does not explicitly state when to use this tool versus alternatives (e.g., coding_read_code) or provide exclusion criteria.

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/RPasquale/lightbulb-mcp'

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