Skip to main content
Glama
irfanfath123

homelab-monitor-mcp

by irfanfath123

read_file

Read text files from local or remote homelab hosts with line pagination, supporting offset and limit parameters for safe, read-only inspection of project files.

Instructions

Read a text file with line pagination (read-only)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNoServer name from HOMELAB_HOSTS (e.g. 'sil-baru'). Omit to run on the local machine.
pathYesAbsolute path inside HOMELAB_PROJECT_DIRS (e.g. '/home/user/projects/api')
limitNoMax lines to read (default 200, max 500)
offsetNoFirst line to read (default 1)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses only that the operation is read-only and that output is paginated by lines; it omits what happens with missing paths, permission failures, non-text/binary files, or how the host parameter affects execution.

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?

A single tight phrase with the core action and safety profile front-loaded — no wasted words. It is arguably under-specified rather than verbose, which is a completeness concern rather than a conciseness one.

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 four-parameter read tool with full schema coverage and no output schema, the description covers the essentials: action, pagination, and non-mutating nature. It leaves gaps around file-type expectations, encoding, and error behavior, but nothing an agent strictly needs to construct a valid call is absent.

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 description coverage is 100%, so the schema already documents host, path, limit, and offset including defaults and bounds. The description adds only the pagination concept, which the schema's limit/offset descriptions already convey, so baseline 3 applies.

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 ('Read a text file') plus a scope qualifier (line pagination), which cleanly separates it from siblings like edit_file and list_dir. It does not explicitly name the sibling it contrasts with, but the read-only framing makes differentiation easy.

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?

The '(read-only)' tag implies this is the non-mutating counterpart to edit_file, but there is no explicit when-to-use statement, no conditions or prerequisites, and no routing to alternatives such as list_dir for directory enumeration. Nothing tells the agent when to prefer this over other read paths.

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