Skip to main content
Glama
Knuckles-Team

Repository Manager

Get readme

repository_manager_get_readme
Read-onlyIdempotent

Retrieve the README.md content and file path from a specified repository directory, or default path, to inspect project documentation and usage details.

Instructions

Get the content and path of the README.md file in the specified path.

Args: path (str, optional): The directory path. Defaults to self.path.

Returns: ReadmeResult: Object containing 'content' and 'path' of the README.md file.

Input Schema

NameRequiredDescriptionDefault
pathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.5.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds genuinely useful behavior beyond that: the default resolution of path against self.path, and — with no output schema present — the shape of the return value (an object with 'content' and 'path'). It omits failure behavior when no README exists, which keeps it from a 5.

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?

Front-loaded with the core action, then a compact Args/Returns block. Every line carries information, though the docstring scaffolding ('Args:', 'Returns:') is slightly heavier than necessary for one optional parameter.

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 one-optional-parameter read tool with no output schema, the description supplies both the parameter default and the return shape, so an agent can call it and interpret the result. The main gap is unstated error handling when the README is missing.

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 description coverage is 0%, so the description carries the full burden and does document the single parameter: it is the directory path and defaults to self.path. This gives meaning the bare anyOf/null schema does not, though 'self.path' is left unexplained.

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 and resource ('Get the content and path of the README.md file') which is unambiguous and, given no sibling tool touches README files, is easy to tell apart in this large sibling set. It stops short of explicitly contrasting with any other tool, but the resource itself is distinctive.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use or when-not guidance, no prerequisites, and no mention of an alternative tool. The only contextual hint is that path 'Defaults to self.path', which is a routing detail rather than usage guidance.

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

Deploy Server

Other Tools