Skip to main content
Glama
Sign In
repo-inspector-mcp

repo-inspector-mcp

by mi6gin
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

read_file

Read a UTF-8 text file from the repository root to inspect its contents. Specify the file path and optional character limit to retrieve the content.

Instructions

Read a UTF-8 text file within the configured repository root.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
max_charsNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the disclosure burden. It usefully discloses the UTF-8 encoding requirement and the repository-root confinement, which set agent expectations about path handling. It does not disclose behavior on missing files, non-UTF-8 content, or how max_chars truncation affects the returned content, though the output schema partially covers return values.

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?

A single 12-word sentence that leads with the verb, states the resource, and closes with the scope constraint. Every word earns its place with zero redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-file tool with an output schema, the description is mostly adequate, covering target resource and path scope. However, with 0% schema parameter coverage and no annotations, the missing explanation of max_chars and edge-case behavior leaves noticeable gaps an agent must resolve elsewhere.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate, but it only does so for path via the 'repository root' scoping hint. The max_chars parameter receives no explanation beyond its title and default, leaving the agent to guess at truncation semantics and units.

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 a specific verb (Read), a precise resource (UTF-8 text file), and a scope constraint (within the configured repository root). This clearly distinguishes it from siblings list_files and search_in_repo, which cover enumeration and content search respectively.

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?

Usage context is implied: an agent reads a file when it needs its contents, rather than listing files or searching for matches. However, there is no explicit guidance about when to prefer this over search_in_repo, which could also surface file content, and no mention of prerequisites or exclusions.

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