Skip to main content
Glama

Read file on VPS

vps_read_file
Read-only

Read file content from a VPS via SFTP. Supports utf8 (text) and base64 encoding. Text over 256 KB is shortened, keeping the start and the end; larger base64 reads fail.

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": {
      "id": "<id>",
      "path": "<path>"
    },
    "name": "vps_read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe VPS ID
pathYesAbsolute path of the file to read
encodingNoOutput encoding (default utf8)

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.9/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses concrete runtime behavior: text responses over 256 KB are shortened by keeping the start and end, and large base64 reads fail outright. That is genuinely decision-relevant context an agent could not get from the schema. Gaps remain around permissions/SSH auth requirements and what happens on missing paths.

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?

Three short sentences, front-loaded with purpose, then encoding support, then the size/truncation caveat. Every sentence carries information that affects how the tool is called.

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 three-parameter read tool with no output schema, the description covers purpose, encoding modes, and the truncation/failure boundaries. It stops short of describing the returned payload shape (e.g., a content field) or error behavior for nonexistent paths, which matters without an output schema.

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 coverage is 100%, so a baseline of 3 would apply, but the description adds real meaning to the encoding parameter by clarifying that utf8 is treated as text and that the two encodings have different size limits. This goes beyond the schema's terse enum labels.

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 gives a specific verb and resource ("Read file content from a VPS via SFTP"), which is clearly distinct from write-oriented siblings like vps_write_file. It does not explicitly name or contrast with any sibling such as vps_list_files or webspace_read_file, so sibling differentiation is left to inference.

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 is only implied: the tool is for reading a known absolute path over SFTP. There is no explicit statement of when to prefer this over vps_list_files or the webspace counterpart, and no prerequisites or exclusions are given.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.