Skip to main content
Glama
oceanum-io

Oceanum MCP

Official
by oceanum-io

Storage Read File

storage_read_file

Read a text file from Oceanum storage by supplying its path. Retrieve file contents for analysis, processing, or display in AI workflows.

Instructions

Read the contents of a text file from Oceanum storage.

Input Schema

NameRequiredDescriptionDefault
pathYesPath to the file.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.2

TDQS

B3.4/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; 'Read' implies a non-mutating operation, and the 'text file' qualifier usefully signals that binary content may be unsupported. However, it says nothing about missing-file behavior, permissions, encoding, or size limits, which are real risks for a file fetch.

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?

A single tight sentence that front-loads the action and resource with zero filler. Correctly sized for a one-parameter tool.

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?

The tool is simple, the sole parameter is documented in the schema, and an output schema exists so return values need not be described. Only error/edge-case behavior (missing file, binary content) is left unaddressed.

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?

Only one parameter exists and schema description coverage is 100%, so the schema already documents 'path' fully. The description adds no path syntax, relative-vs-absolute, or format detail beyond what the schema provides, so the 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 (read) and resource (contents of a text file) scoped to Oceanum storage, which cleanly distinguishes it from write/delete/list siblings. It stops short of naming an alternative or explicitly contrasting with storage_list_files or storage_file_info.

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?

There is no explicit when-to-use guidance, no prerequisites, and no reference to alternatives such as storage_file_info (metadata) versus this tool (contents). Usage is only inferable from the verb.

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