Skip to main content
Glama

set_required_checks

Define the test and lint commands that a pull request must record as passing checks when the project's CI is local. Replaces the required list; an empty list requires none.

Instructions

Set the commands a pull request of this project must have recorded as passing checks when its CI is the local integration (the ci slot is local): the test and lint commands from the project's AGENTS.md, exactly as a builder runs them. Replaces the list; an empty list means the project requires none. For the project's lead or an admin, not a crew station.

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": {
      "commands": "<commands>"
    },
    "name": "set_required_checks"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectNo
commandsYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses that the operation overwrites the existing list, that an empty list clears requirements, and that lead/admin authorization is required. It stops short of saying what happens if the project's CI is not local or whether partial failures are possible.

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

Conciseness4/5

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

Two sentences, front-loaded with the core action, followed by the replacement semantics and authorization. Dense and mostly waste-free, though the nested parenthetical makes the first sentence harder to parse than necessary.

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 small mutation tool with an output schema and no annotations, the description covers the destructive semantics, the applicability condition, and the auth model. The main remaining gap is the undocumented `project` parameter and behavior when the CI slot is not local.

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 coverage is 0%, so the description must compensate. It adds real meaning for `commands` (test and lint commands from the project's AGENTS.md, exactly as a builder runs them), but says nothing about the `project` parameter, including its empty default.

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?

States a specific verb (Set) and a precisely scoped resource: the commands a PR must have recorded as passing checks, limited to projects whose `ci` slot is `local`. The clause 'Replaces the list; an empty list means the project requires none' also implicitly distinguishes it from an additive sibling such as add_check.

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?

Gives a clear precondition (only when the `ci` slot is `local`) and an authorization boundary ('For the project's lead or an admin, not a crew station'). It does not name an alternative tool for the non-local case, but the condition for use is explicit.

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