Skip to main content
Glama
ossmalaysia

codex-local-mcp

by ossmalaysia

Read a file produced by Codex

codex_read_artifact

Read large artifact files from a Codex workspace, returning images as image content and other files as text.

Instructions

Read one file from a Codex workspace, for artifacts that were too large to inline. Images come back as image content, everything else as text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the file, relative to the workspace root or absolute inside it.
max_bytesNoRefuse files larger than this. Default 5000000.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral disclosure burden. It adds useful detail by stating that images come back as image content and everything else as text, and the verb 'Read' implies a non-mutating operation. It does not cover error cases or permissions, but for this simple read tool that is a minor gap.

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?

Two short sentences with no filler. The purpose is front-loaded, and the second sentence efficiently clarifies the output format, which is the key behavioral detail.

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 tool with only two parameters and no output schema, the description plus schema cover the essential invocation information: purpose, path semantics, size limit, and output type. It is slightly light on failure behavior, but nothing critical is missing for an agent to call it correctly.

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 both parameters. The description adds a little context by framing path as a file in a Codex workspace, but it does not meaningfully expand on parameter semantics beyond the schema.

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 states a specific verb and resource: 'Read one file from a Codex workspace', and explains the target use case ('artifacts that were too large to inline'). It is clearly distinct from codex_run and codex_generate_image in both action and resource.

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?

The description gives a clear condition for use: when a Codex artifact was too large to inline. It does not explicitly name alternatives or exclusions, but the context is sufficient to distinguish it from its siblings.

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