Skip to main content
Glama
0aaryan

hypr-tools

by 0aaryan

read_file

Read-only

Read file contents within the home directory sandbox to inspect configs, logs, or scripts, with an optional maximum line limit.

Instructions

Read the contents of a file (sandboxed to home directory). Use for configs, logs, scripts.

Input Schema

NameRequiredDescriptionDefault
pathYesFile path (absolute or ~/relative)
max_linesNoMax lines to return (default 200)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds important behavioral context by noting that reads are sandboxed to the home directory, though it does not discuss truncation, errors, or binary handling.

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 two short sentences with no wasted text. The core action and sandbox constraint are front-loaded, and the usage examples follow efficiently.

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 file-read tool with rich schema coverage and clear annotations, the description supplies the key scope and use-case context. It could be slightly more complete by mentioning return/truncation behavior, but no output schema exists and the description remains adequate.

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%, and both parameters are documented in the schema. The description does not add parameter-specific meaning beyond the schema, so the baseline score of 3 is appropriate.

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?

The description uses a specific verb and resource ('Read the contents of a file') and adds scope ('sandboxed to home directory'). This clearly separates it from write_file, list_directory, and file_info by intent, though it does not explicitly name those siblings.

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

Usage Guidelines4/5

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

It gives concrete usage context ('Use for configs, logs, scripts'), which helps an agent decide when this is appropriate. It does not explicitly state exclusions or point to alternatives such as list_directory or file_info.

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