Hercules MCP

Overview Schema Source Related Servers Discussions Admin

workspace_read_file

Read content from files inside a containerized workspace up to a bounded size, supporting text and base64 encoding while enforcing path restrictions.

Instructions

Purpose: Read a bounded file chunk inside the owned container workspace. Constraints: Relative paths resolve under /opt/workspace. Paths outside it and symlink/reparse escapes are rejected. encoding='base64' reads binary data. For large files… Example: workspace_read_file(path='nuclei-templates/custom/check.yaml')

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": "workspace_read_file"
  }
}

Input Schema

Name	Required	Default
`path`	Yes
`offset`	No
`encoding`	No	text
`max_bytes`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Aug 8, 2026

TDQS

B3.3/5.0

Behavior3/5

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

With no annotations, the description must carry the full burden of behavioral disclosure. It reveals path restrictions and encoding behavior, but leaves offset/max_bytes semantics and return format unexplained. The truncated 'For large files...' sentence also detracts from completeness.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with 'Purpose' and 'Constraints' labels and a concise example. However, the incomplete sentence 'For large files…' breaks the flow and suggests missing content, detracting from the overall structure.

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

Completeness2/5

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

Given the tool has 4 parameters and no schema descriptions, the description is insufficient. It fails to explain how offset and max_bytes work, how bounded reads operate, and the handling of large files. The presence of an output schema does cover return values, but key usage details are absent.

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. It explains path resolution and encoding meaning, but offset and max_bytes are not described. This leaves two of four parameters without semantic clarity beyond their names.

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 explicitly states 'Read a bounded file chunk inside the owned container workspace', using a specific verb and resource that clearly distinguishes it from sibling tools like workspace_write_file. The example further clarifies usage.

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 for reading files within the workspace but provides no explicit guidance on when to use this tool versus alternatives like shell_exec. It mentions constraints but no exclusions or alternative tool recommendations.

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