Skip to main content
Glama

BCD — Bridge Control Delegate

read_file

Read-only

Read a file. Text: offset is the zero-based first line and length the line count (default 1000); a negative offset reads the last N lines. Returns a "[Reading N lines from … (total: T lines, R remaining)]" header, then the text. Also reads images (as images), PDF (offset/length count pages; options.ocr auto|force|off, Korean/English OCR), DOCX (outline; docxMode text|outline|xml) and spreadsheets (sheet, range: 2D values). For web pages use read_url.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
isUrlNo
rangeNo
sheetNo
lengthNo
offsetNo
optionsNo
deviceIdNoComputer name or id from list_devices. Optional with one computer online or a default set.
docxModeNo
docxPartNo
maxBytesNo
maxImagesNo
extractImagesNo
workSessionIdNoWork session from create_work_session. Pass the same ID on every call in this conversation; omit for legacy unscoped work.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / workSessionId
      Added value: +{
      +  "description": "Work session from create_work_session. Pass the same ID on every call in this conversation; omit for legacy unscoped work.",
      +  "format": "uuid",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false, and openWorldHint, so the safe-read profile is covered. The description adds genuine behavioral detail beyond that: the exact return header format, per-format interpretation of offset/length, and the OCR modes. It omits rate limits and permission/auth requirements, but for a read tool this is a solid addition.

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

Conciseness4/5

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

Front-loads the core verb, then uses a compact per-format structure that lets each clause earn its place. It is dense and somewhat run-on, but appropriate given 14 parameters and five supported formats.

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?

With no output schema, the description usefully documents the returned reading-header format, which many such tools omit. It is largely complete, though a handful of lower-level parameters (maxBytes, maxImages, extractImages, docxPart) are left undocumented across both schema and description.

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 only 14%, so the description must carry the load, and it does: it defines offset/length semantics for text (zero-based line, default 1000, negative offset reads last N), clarifies they count pages for PDF, and documents options.ocr, docxMode, sheet, and range. Several params (maxBytes, maxImages, extractImages, docxPart, isUrl) remain unexplained in either place, keeping it from a 5.

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?

States a specific verb+resource ("Read a file") and then enumerates the content types it handles (text, images, PDF, DOCX, spreadsheets), so an agent understands the true scope. It also explicitly distinguishes itself from the read_url sibling for web pages.

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?

Gives clear context for when to use it and names one alternative explicitly ("For web pages use read_url"). It does not, however, address the other sibling it overlaps with (read_multiple_files) or when to prefer bulk reads, so guidance is present but not exhaustive.

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.

Resources