Skip to main content
Glama

Plain-English file summary

get_file_summary
Read-onlyIdempotent

Retrieve plain-English summary for an indexed file or symbol, using cached results that update when content changes.

Instructions

Lazy-generate (or return cached) plain-English summary for an indexed file or symbol. Cache invalidates when content_hash changes after re-index.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idNoProject UUID (defaults to configured project)
file_pathYesIndexed file path
symbol_nameNoOptional symbol name within the file
forceNoBypass cache and regenerate
Behavior4/5

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

Annotations already indicate readOnlyHint, idempotentHint, openWorldHint. The description adds behavioral transparency by explaining the lazy/cache mechanism and cache invalidation based on content_hash. No contradiction.

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 sentences: the first states the core purpose, the second adds context about caching. No wasted words, front-loaded and efficient.

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 simple tool with good schema and annotations, the description covers the caching behavior. It does not describe the output format, but 'plain-English summary' is sufficiently clear.

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 coverage is 100% with descriptions for all four parameters. The description does not add significant additional meaning beyond the schema, so baseline 3 is appropriate.

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 action ('lazy-generate or return cached') and the resource ('plain-English summary for an indexed file or symbol'). It differentiates from sibling tools, which are mostly about codebase analysis, reports, and pipelines, not file summaries.

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 context (for indexed files) and mentions cache invalidation, but it does not explicitly state when to use this tool vs alternatives or provide exclusions.

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/kensaurus/mushi-mushi'

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