Skip to main content
Glama
bruhsb
by bruhsb

paperclip_get_run_log

Read-only

Read raw log bytes from a heartbeat run using a byte-offset cursor. Use nextOffset to retrieve subsequent slices of the log output.

Instructions

⚠ Board-only: Read raw log bytes for a heartbeat run using a byte-offset cursor (not paginated).

Args:

  • runId: string — Heartbeat run UUID (example: "run_abc123")

  • offset: number (optional) — Byte offset to start reading from (default 0)

  • limitBytes: number (optional) — Max bytes to return (default 16384 = 16 KiB)

  • response_format: 'markdown' | 'json' (optional) — Output format (default: markdown)

Returns: Log slice object: { content: string, nextOffset: number, totalBytes: number }. Use nextOffset to continue reading.

Examples:

  • Use when: reading raw execution log output for a heartbeat run, advancing via nextOffset for subsequent slices

  • Don't use when: you need structured events — use paperclip_list_run_events with afterSeq cursor instead

Error Handling:

  • 401: authentication failed → check PAPERCLIP_API_KEY

  • 403: permission denied → board-only endpoint, requires board API key

  • 404: run not found → verify runId with paperclip_list_heartbeat_runs

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesHeartbeat run UUID
offsetYesByte offset into the log to start reading from (default 0)
limitBytesYesMaximum bytes to return (default 16384 = 16 KiB)
response_formatYesOutput format: 'markdown' (default, human-readable) or 'json' (structured)markdown
Behavior5/5

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

Annotations declare readOnlyHint=true, and the description adds context about the byte-offset cursor, non-paginated nature, board-only restriction, and authentication requirements, complementing annotations without contradiction.

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?

The description is well-organized into clear sections (Args, Returns, Examples, Error Handling) with no redundant information, each sentence serves a purpose.

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

Completeness5/5

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

All aspects—purpose, usage, parameters, return format, error codes, and continuation mechanism—are covered; no gaps given the tool's simplicity and lack of 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% (baseline 3), but the description explains each parameter's purpose, provides examples, and clarifies the return object structure, adding value 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 uses a specific verb 'read' and identifies the resource as 'raw log bytes for a heartbeat run', and explicitly distinguishes from sibling tool paperclip_list_run_events.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit when-to-use ('reading raw execution log output for a heartbeat run') and when-not-to-use ('need structured events — use paperclip_list_run_events instead'), including error handling guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bruhsb/paperclip-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server