Skip to main content
Glama

Docflow List Review Repos

docflow_list_review_repos

List all review rule repositories in a workspace to identify available compliance rule sets. Returns repo IDs, names, and creation times for quick selection.

Instructions

List all review rule repositories in a workspace (GET /review/rule_repo/list). Returns repo_id, name, and creation time for each.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspace_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations provided, the description carries the behavioral disclosure burden. It openly states this is a GET operation, implying read-only behavior, and specifies the returned fields (repo_id, name, creation time). It does not cover auth, errors, or pagination, but does establish the core side-effect profile.

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?

The description is two tight sentences with no filler. It front-loads the main purpose, provides the exact endpoint, and summarizes the response shape efficiently.

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 description is adequate for a simple listing tool and the output schema handles return values, but it leaves the sole parameter semantically underspecified and gives no guidance on when to prefer this over related review-repo tools. More parameter and usage context would make it fully complete.

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

Parameters2/5

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

Schema description coverage is 0% and the description does not explain the workspace_id parameter. It only refers to 'in a workspace' in a general way, which weakly implies the parameter's role. The description should explicitly state that workspace_id identifies the workspace whose repositories are listed.

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 ('List all review rule repositories'), the scope ('in a workspace'), and the exact endpoint. It is easily distinguished from sibling tools like docflow_get_review_repo or docflow_update_review_repo because the resource and listing behavior are explicit.

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

Usage Guidelines4/5

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

The description clearly implies when to use the tool: when the agent needs an overview of all review rule repositories for a given workspace. It does not explicitly mention alternatives or exclusions, but the 'list all' framing and workspace context provide adequate usage context.

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