Skip to main content
Glama
ibmkevin

github-mcp-server

by ibmkevin

read_file_contents

Read the raw text content of a file from a GitHub repository by specifying owner, repo, and path. Provides the decoded file content for analysis or display.

Instructions

Read the raw text contents of a file from a GitHub repository. Returns the decoded file content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refNoBranch, tag, or commit SHA to read from (defaults to the repo's default branch)
pathYesPath to the file within the repository (e.g. 'src/index.ts')
repoYesRepository name
ownerYesRepository owner (user or organisation)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the core behavior (read and decode) but does not mention potential edge cases like missing files, encoding specifics, or authentication requirements. For a simple read operation, this is acceptable but could be more informative.

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?

The description is a single sentence, concise and to the point, with no wasted words. It front-loads the action and resource, making it easy to scan.

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 read tool with full schema coverage and no output schema, the description adequately conveys the return value (decoded file content). It does not explain error behavior or limitations, but for the intended use, it is sufficient.

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?

The schema description coverage is 100%, meaning all parameters are already documented in the schema. The tool description does not add any extra semantic meaning to the parameters, so the baseline of 3 applies.

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 ('Read the raw text contents of a file') and the resource ('from a GitHub repository'), distinguishing it from the sibling tools (search_repositories, list_issues) which serve different purposes. The verb and object are specific and unambiguous.

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: when you need file contents, use this tool. However, it does not explicitly mention when not to use it or name alternatives. Since the siblings are clearly different, the guidance is adequate but not explicit.

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