Skip to main content
Glama
Sign In
chrischall

honeybook-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_workspace_file

Read-only

Retrieve detailed info for a single HoneyBook workspace file, returning a compact summary or drilling into pricing, agreement, payments, or the full response.

Instructions

Get detail for one workspace file. Returns a compact summary by default (metadata, vendor, event, pricing totals, payment schedule, agreement presence). Use section to drill into a specific part of the file: "pricing" for full line items + tax/svc detail, "agreement" for contract HTML + signatures, "payments" for full payment-schedule detail, "all" for the pruned full response, or "raw" for the entirely-unpruned response (may exceed MCP size limits on proposal-class files).

Input Schema

NameRequiredDescriptionDefault
originNoPortal origin (e.g. https://<vendor>.hbportal.co). Optional when only one session is active.
file_idYesThe file _id from list_workspace_files.
sectionNoWhich view to return. Default "summary" (~5-15 kB). Others return focused sections of the raw response.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.3.1

TDQS

A4.3/5.0
Behavior4/5

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

With readOnlyHint and openWorldHint already declaring the safety profile, the description adds real behavior: the default is a compact summary (~5-15 kB) and 'raw' may exceed MCP size limits on proposal-class files. This size/side-effect context goes beyond the annotations usefully.

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?

Purpose is front-loaded, followed by enumerated section semantics. Slightly long but every clause earns its place; minor redundancy between naming the section and describing its content.

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?

No output schema exists, so the description must carry return-value context, and it does by describing what each section returns. Adequate for a single-file detail tool, though the origin parameter and its session dependency are not elaborated here.

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), and the description still adds meaning by spelling out what each section returns (line items + tax/svc, contract HTML + signatures, full payment schedule), which the enum description does not fully capture.

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 ('Get detail for one workspace file') and clarifies its scope versus the list sibling (single file, not a list). The default response shape is described, so an agent immediately knows what this returns relative to list_workspace_files.

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 guidance on when to use each `section` value (pricing for line items, agreement for contract HTML, raw for unpruned). It does not explicitly name alternative tools, but the drill-down guidance is actionable and context is clear.

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