Skip to main content
Glama
Sign In
chrischall

honeybook-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

list_workspace_files

Read-only

Fetch all files a vendor shared with you, including contracts, invoices, brochures, and proposals, with optional filtering by file type.

Instructions

List all files a vendor has shared with you (contracts, invoices, brochures, proposals). Optionally filter by file_type. Follows every page; returns { files, complete } — complete:false means some files could not be fetched. Each file is a light summary row by default (id, title, type, status, sent date, workspace, payment/acceptance flags); call get_workspace_file with its _id for pricing, contract or payments, or pass view="all" for every pruned file object (large).

Input Schema

NameRequiredDescriptionDefault
viewNoDefault "summary": one light row per file. "all": each file object with the heavy vendor-side company fields pruned (can be hundreds of kB per proposal).
originNoPortal origin (e.g. https://<vendor>.hbportal.co) to target. Optional — defaults to the most recently activated session.
file_typeNoFilter to one file type. Omit to return all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.7
    • addedInput schema / properties / view
      Added value: +{
+  "description": "Default \"summary\": one light row per file. \"all\": each file object with the heavy vendor-side company fields pruned (can be hundreds of kB per proposal).",
+  "enum": [
+    "summary",
+    "all"
+  ],
+  "type": "string"
+}
  2. 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"
  3. First observedv0.3.1

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare readOnlyHint and openWorldHint, so the description carries the rest and does so well: it discloses pagination behavior ("Follows every page"), the exact return shape { files, complete }, and the meaning of complete:false. It also warns that view="all" produces large payloads (hundreds of kB per proposal) and enumerates the default summary row fields.

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?

Front-loaded with the core action, then streamed as tight clauses covering filtering, pagination, return shape, and the drill-down path. Every sentence carries information; nothing is redundant with the schema or annotations.

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?

No output schema exists, yet the description fully specifies the return envelope, the failure signal (complete:false), default vs. full row shape, and the follow-up tool. Nothing an agent needs to invoke it correctly is missing.

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%, so the baseline is 3, but the description adds value beyond the schema by describing the default summary row contents and the size tradeoff of view="all". It does not restate origin's session-defaulting behavior, which stays in 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?

States a specific verb+resource (list all files a vendor has shared) and enumerates the domain objects (contracts, invoices, brochures, proposals). It is immediately distinguishable from the sibling get_workspace_file, which it explicitly names as the drill-down alternative.

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?

Gives explicit routing: use this list tool by default, call get_workspace_file with a row's _id when pricing/contract/payment details are needed, and only pass view="all" when every pruned file object is required. Optional file_type filtering is also covered with an omit-to-return-all default.

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