Skip to content
GitmoapAPIBeta
Planissue-criteria
GET/issue-criterion-kinds

The catalogue of acceptance-criterion kinds and their argument field schemas

list_criterion_kinds
  • issue:read
    A token needs the issue:read scope: Read work items and their settingsGranted by mcp_agent, mcp_agent_write, read_api, read_repository, write_api, write_repository.Every operation this scope unlocks
  • Single-resource

    x-gitmoap-isolation: {"kind":"single_or_self_scoped"}

Lists every kind of acceptance criterion — manual, test, metric, coverage, node and scorecard_check, which is filed automatically and cannot be authored — each with a label, help text, its typed argument fields and a JSON Schema for them, enough to build one authoring form per kind. The catalogue is the same for everyone, and any signed-in caller may read it.

Responses

200Every criterion kind with its argument field schemaapplication/json
  • kindsarray of CriterionKindDescriptor
    • The CriterionKindDescriptor schema
    • config_schemaobjectA JSON Schema over the fields — render a form from this.
    • descriptionstring
    • evaluablebooleanWhether the platform evaluates this kind from evidence (i.e. it is a real binding, not a manual checkbox).
    • fieldsarray of FieldDescriptorThe typed argument fields.
    • kindCriterionKindmanualtestmetriccoveragenodescorecard_checkA kind of acceptance criterion. Manual is a human-ticked checkbox (no binding); the rest bind to a predicate the platform evaluates from pipeline evidence.
    • labelstring
200 exampleSynthesized example
{
"kinds": [
{
"config_schema": {},
"description": "Renders each region as density contours of its operations.",
"evaluable": false,
"fields": [],
"kind": "manual",
"label": "label-d675"
}
]
}
401application/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-6f08",
"message": "Label every synthesized example"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-4d73",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap issue-criteria list-kinds

Used in these guides