Skip to main content
Glama
Sign In
docflow-mcp

docflow-mcp

by intsig-textin
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Docflow Setup Review Rules

docflow_setup_review_rules

Create an idempotent rule repository to organize compliance review rules by groups, reusing an existing repo when the name matches.

Instructions

Create a review rule repository (idempotent — reuses existing repo if name matches).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>",
      "repo_name": "<repo_name>",
      "rule_groups": "<rule_groups>"
    },
    "name": "docflow_setup_review_rules"
  }
}

Input Schema

NameRequiredDescriptionDefault
repo_nameYesName for the rule repository.
rule_groupsYesList of rule group definitions: [{"name": "组名", "rules": [ {"name": "规则名", "prompt": "审核判断提示词", "category_ids": ["cat_id"], "risk_level": 10} ]}] risk_level: 10=high, 20=medium, 30=low.
workspace_idYesTarget workspace.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It discloses the important idempotent behavior ('reuses existing repo if name matches'), which is valuable. However, it doesn't explain what happens to the provided rule_groups when an existing repo is reused — whether they are applied, merged, or ignored — nor does it mention permissions or side effects beyond creation.

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?

A single short sentence with zero filler. The core action and the key idempotent behavior are front-loaded. Every word earns its place.

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

Completeness3/5

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

The output schema covers return values and the input schema covers parameters, so the main gap is behavioral context. The description leaves unclear what happens when a repository with the same name already exists but different rule_groups are passed — a materially ambiguous outcome for a mutating setup tool. It is adequate for simple use but incomplete for correct repeated invocations.

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 the schema already documents all three parameters in detail, including the rule_groups format. The description adds little beyond reinforcing the 'name matches' reuse concept for repo_name. The baseline of 3 applies because the schema does the heavy lifting.

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?

The description clearly states a specific action ('Create a review rule repository') and a specific resource. It adds the idempotent reuse behavior, which helps define what the tool does. It doesn't explicitly differentiate from sibling tools like docflow_update_review_repo, but 'create' + 'repository' is specific enough.

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?

The description gives no guidance on when to use this tool versus alternatives such as docflow_update_review_repo, docflow_update_review_rule_group, or docflow_list_review_repos. There is no mention of exclusions, prerequisites, or preferred conditions for selection.

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