Skip to main content
Glama

Docflow Add Category Fields

docflow_add_category_fields

Add custom fields to an existing document category to capture additional metadata during classification and extraction.

Instructions

Add fields to an existing category (POST /category/fields/add).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsYesFields to add. Format: [{"name": "字段名", "description": "可选描述"}]
category_idYes
workspace_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.2/5.0
Behavior1/5

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

With no annotations, the description carries the full burden of behavioral disclosure, but it only states the operation. It does not mention whether the operation is destructive, what happens if fields already exist, whether it requires specific permissions, or what the response format is. It adds no behavioral context beyond the trivial.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that is front-loaded with the purpose, which is good. However, it is so terse that it omits necessary context. It is concise but under-specified, bordering on under-specification rather than effective conciseness.

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

Completeness1/5

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

Given the tool has three required parameters and an output schema, the description is incomplete. It does not mention prerequisites, error conditions, or the shape of the response. Even though an output schema exists, the description should at least indicate that a confirmation is returned or any side effects. It is minimal to the point of being insufficient.

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

Parameters1/5

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

The description does not explain any of the three parameters. The schema provides a description for 'fields' with an example, but 'workspace_id' and 'category_id' are undocumented. The description fails to compensate for the 33% schema coverage, leaving the agent without guidance on what these IDs refer to.

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 clearly states the action ('Add fields') and the resource ('an existing category'), with the HTTP endpoint as technical context. This distinguishes it from sibling tools like docflow_update_category_field (which updates existing fields) and docflow_create_category (which creates a category). The verb and resource are specific and unambiguous.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives. It does not mention related tools like docflow_update_category_field or docflow_list_category_fields, nor any conditions that would select this tool. An agent would have to infer usage from the name alone.

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