Skip to main content
Glama

List rulesets

list_rulesets
Read-only

List the project's rulesets with their rules and, in attachedTo, the workflows and connections each one is attached to. A ruleset is a name and ordered rules; each rule is one statement at level must (a failure refuses the write) or should (a failure is reported). Rules run only inside workflow runs: a ruleset is checked when it is attached to a workflow connection (rulesetIds in update_workflow) and the write that completes that step happens.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesId of the Project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds genuine behavioral context beyond that: it discloses the shape of the returned data (rules plus an attachedTo map of workflows and connections), which matters since there is no output schema.

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 core purpose is front-loaded in the first sentence, but the remaining text drifts into domain exposition (must/should semantics, when rules execute) and references another tool's parameter. For a one-parameter list operation, some of this narrative is tangential rather than load-bearing.

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?

With no output schema, the description responsibly describes what comes back (each ruleset's rules and its attachedTo workflows/connections), so an agent knows what to expect. For a simple single-param read tool this is close to complete, though pagination or ordering behavior is unaddressed.

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?

The single projectId parameter has 100% schema description coverage ('Id of the Project'), so the schema does the heavy lifting and baseline 3 applies. The description adds no format or constraint detail for the parameter; its mention of rulesetIds refers to update_workflow, not this tool's input.

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 first sentence states a specific verb and resource ('List the project's rulesets') and immediately scopes the output ('with their rules and, in attachedTo, the workflows and connections'). This is clearly distinguishable from create_ruleset, update_ruleset, delete_ruleset, and create_rule without opening any schema.

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 explains the domain model (what a ruleset is, when rules run) but never says when to call this tool versus siblings like check_rules, get, or list_workflows, nor any exclusion or precondition. The only routing-like hint is that rules are checked inside workflow runs, which is context about rulesets generally, not guidance for invoking this tool.

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.

Resources