Skip to main content
Glama
chrischall

honeybook-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_flow

Read-only

Read a HoneyBook questionnaire's pages, questions, and submitted answers using a captured flow credential; defaults to the most recent flow and supports compact or raw views.

Instructions

Read a HoneyBook questionnaire (flow) — its pages, questions and any answers already submitted — using a credential captured by use_flow_link. Requires a flow credential; a client-portal session will NOT work here, and vice versa. Defaults to the most recently captured flow. Makes two calls: the public /api/v2/flow//minimal for the vendor company id, then /api/v2/client/flow//active, passing that id as ?ctxc= when /minimal supplied one. A questionnaire larger than the default ceiling answers with its size and top-level keys instead; call again with view="raw" for the whole thing.

Input Schema

NameRequiredDescriptionDefault
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "raw" returns the upstream payload unprojected. compact returns the questionnaire unless it exceeds a byte ceiling, in which case it answers with its size and top-level keys instead; "raw" returns the full payload however large (may exceed MCP size limits).
flow_idNoFlow id to read. Omit to use the most recently captured flow credential. Run `list_active_sessions` to see the active flow ids.

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. Changed2 schema fields changedv0.10.1
    • removedInput schema / properties / section
      Removed value: -{
-  "description": "Default \"summary\" returns the questionnaire unless it exceeds a byte ceiling, in which case it answers with its size and top-level keys instead. \"raw\" returns the full payload however large (may exceed MCP size limits).",
-  "enum": [
-    "summary",
-    "raw"
-  ],
-  "type": "string"
-}
    • addedInput schema / properties / view
      Added value: +{
+  "description": "Response shape: \"compact\" (default) drops fields the response already carries elsewhere; \"raw\" returns the upstream payload unprojected. compact returns the questionnaire unless it exceeds a byte ceiling, in which case it answers with its size and top-level keys instead; \"raw\" returns the full payload however large (may exceed MCP size limits).",
+  "enum": [
+    "compact",
+    "raw"
+  ],
+  "type": "string"
+}
  3. Addedv0.9.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnly/openWorld, but the description adds substantial behavior: the two-call sequence to the public /minimal then /active endpoints with the ?ctxc= parameter, the default-to-latest-flow behavior, and the size-ceiling fallback that returns size and top-level keys until view="raw" is requested. This is real operational context beyond the annotations.

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 purpose and credential requirements, then layers the two-call mechanics and fallback behavior. Every sentence is informative, though the low-level endpoint paths are more implementation detail than an agent strictly needs to select and invoke the tool.

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?

With no output schema, the description still explains the response shape (compact projection vs raw payload), the truncation fallback, and the credential environment. An agent has everything needed to call it and interpret a size-only response.

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 description coverage is 100%, so both params are already documented, and the description largely restates the compact/raw distinction. It does add workflow meaning by framing view="raw" as the recovery step after a ceiling-truncated response, which links the parameter to observable behavior rather than repeating it.

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 and resource ('Read a HoneyBook questionnaire (flow)') and enumerates what is returned — pages, questions and submitted answers. This distinguishes it cleanly from generic siblings like get_project or get_workspace, and it ties the tool to the flow credential realm.

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?

Explicitly states the prerequisite (a credential captured by `use_flow_link`), the exclusion ('a client-portal session will NOT work here, and vice versa'), the default behavior ('most recently captured flow'), and points to `list_active_sessions` for ids. When-to-use and when-not are both spelled out.

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