Skip to main content
Glama

Craftboxx MCP by usefulapi

List documentations

craftboxx_list_documentations
Read-only

List job documentations (reports written on assignments: title, state, type, author). Craftboxx API: GET /documentations.

Input Schema

NameRequiredDescriptionDefault
qNoFree-text search across the relevant fields.
pageNoPage number (default 1).
per_pageNoResults per page.
author_idNoOnly documentations written by this employee.
assignment_idNoOnly documentations of this assignment.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, and the description adds valuable context beyond that: a documentation is a report written on an assignment and returns title, state, type, and author. It also cites the backing endpoint GET /documentations, though it does not mention pagination behavior.

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?

Two tight sentences: the purpose and its definition are front-loaded, followed by the API reference. There is no wasted verbiage.

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?

For a 5-optional-parameter read-only list tool with no output schema, the description supplies the return fields and resource definition, which is exactly what fills the output-schema gap. Only pagination/result-shape nuance is left unstated, a minor omission given the schema covers the paging params.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so q, page, per_page, author_id, and assignment_id are already documented in the schema. The description adds no filter semantics beyond that, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a clear verb and resource (list job documentations) and clarifies what a documentation is (reports written on assignments) with its fields. This conceptually distinguishes it from siblings like list_assignments, though it never names a sibling explicitly.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no exclusions, and no mention of when to prefer list_assignments versus list_documentations. Usage is only implied by the name and the parenthetical definition.

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.