Skip to main content
Glama

Drupal Code Query

by tech.tresbien
OverviewDiscussionsAdmin

Project upgrade readiness

project_upgrade_report
Read-onlyIdempotent

Answer "is this contrib project ready for a target core version, and what work is left". For one record's detail, use get_change_record. For a symbol's users, use list_symbol_users.

  • A record applies when it targets the target version or earlier, and a development branch of the project matched one of its tracks.

  • Verdict per record: outstanding (a branch still calls the going-away side), in_progress (some branches moved), adopted (all moved).

  • Returns counts by verdict, then a ranked head of outstanding records with file and line evidence from the project's own code.

  • Each entry has the count of other projects outstanding on the same record, and its nid for get_change_record.

  • removed_symbols: core symbols removed by the target, or scheduled for removal at or before it, that the project's development branches still reference. Each has occurrences, files, and the replacement when the catalog lists one. They need no change record: a class moved to another module, a service dropped. removed_symbol_count: the whole set. The head is newest removal first, then by occurrences. Test and test-support symbols are left out.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoOutstanding records to return with evidence, 1 to 15 (default 8). Above the cap the call is refused.
projectYesContrib project machine name as it appears on drupal.org, for example webform. The composer name drupal/webform is accepted. Packages from other vendors are not in the dataset.
target_versionYesTarget core version: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / project / description
      Previous value: -"Contrib project machine name as it appears on drupal.org, for example webform. The composer name drupal/webform is accepted. Packages from other vendors (acquia/cohesion) are not in the dataset."New value: +"Contrib project machine name as it appears on drupal.org, for example webform. The composer name drupal/webform is accepted. Packages from other vendors are not in the dataset."
  2. Changed3 schema fields changed
    • changedInput schema / properties / limit / description
      Previous value: -"How many outstanding records to return with evidence, 1 to 15 (default 8); above the cap the call is refused."New value: +"Outstanding records to return with evidence, 1 to 15 (default 8). Above the cap the call is refused."
    • changedInput schema / properties / project / description
      Previous value: -"Contrib project machine name as it appears on drupal.org, for example webform; the composer name drupal/webform is accepted. Packages from other vendors (acquia/cohesion) are not in the dataset."New value: +"Contrib project machine name as it appears on drupal.org, for example webform. The composer name drupal/webform is accepted. Packages from other vendors (acquia/cohesion) are not in the dataset."
    • changedInput schema / properties / target_version / description
      Previous value: -"Target core version. Write it the way people say it: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it."New value: +"Target core version: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it."
  3. Changed1 schema field changed
    • changedInput schema / properties / target_version / description
      Previous value: -"Target core version. Write it the way people say it: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major means the end of that major."New value: +"Target core version. Write it the way people say it: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it."
  4. Changed1 schema field changed
    • changedInput schema / properties / project / description
      Previous value: -"Contrib project machine name as it appears on drupal.org, for example webform."New value: +"Contrib project machine name as it appears on drupal.org, for example webform; the composer name drupal/webform is accepted. Packages from other vendors (acquia/cohesion) are not in the dataset."
  5. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
-  "additionalProperties": false,
-  "properties": {
-    "axis": {
-      "type": "string"
-    },
-    "branches": {
-      "additionalProperties": false,
-      "properties": {
-        "in_flight": {
-          "type": "integer"
-        },
-        "legacy": {
-          "type": "integer"
-        },
-        "migrated": {
-          "type": "integer"
-        }
-      },
-      "required": [
-        "legacy",
-        "in_flight",
-        "migrated"
-      ],
-      "type": "object"
-    },
-    "computed_at": {
-      "type": [
-        "null",
-        "string"
-      ]
-    },
-    "outstanding": {
-      "items": {
-        "additionalProperties": false,
-        "properties": {
-          "evidence": {
-            "items": {
-              "additionalProperties": false,
-              "properties": {
-                "branches": {
-                  "type": "integer"
-                },
-                "lines": {
-                  "type": "string"
-                },
-                "path": {
-                  "type": "string"
-                },
-                "symbol": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "path"
-              ],
-              "type": "object"
-            },
-            "type": [
-              "null",
-              "array"
-            ]
-          },
-          "files": {
-            "type": "integer"
-          },
-          "flavor": {
-            "type": "string"
-          },
-          "legacy_branches": {
-            "type": "integer"
-          },
-          "nid": {
-            "type": "integer"
-          },
-          "peer_projects": {
-            "type": "integer"
-          },
-          "target_version": {
-            "type": "string"
-          },
-          "title": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "nid",
-          "title",
-          "flavor",
-          "target_version",
-          "legacy_branches",
-          "peer_projects",
-          "evidence",
-          "files"
-        ],
-        "type": "object"
-      },
-      "type": [
-        "null",
-        "array"
-      ]
-    },
-    "project": {
-      "type": "string"
-    },
-    "records": {
-      "additionalProperties": false,
-      "properties": {
-        "adopted": {
-          "type": "integer"
-        },
-        "in_progress": {
-          "type": "integer"
-        },
-        "outstanding": {
-          "type": "integer"
-        },
-        "total": {
-          "type": "integer"
-        }
-      },
-      "required": [
-        "outstanding",
-        "in_progress",
-        "adopted",
-        "total"
-      ],
-      "type": "object"
-    },
-    "target_version": {
-      "type": "string"
-    },
-    "truncated": {
-      "type": "boolean"
-    }
-  },
-  "required": [
-    "project",
-    "target_version",
-    "axis",
-    "records",
-    "branches",
-    "outstanding",
-    "truncated",
-    "computed_at"
-  ],
-  "type": "object"
-}New value: +null
  6. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"How many outstanding records to return with evidence. Defaults to 8, capped at 15."New value: +"How many outstanding records to return with evidence, 1 to 15 (default 8); above the cap the call is refused."
  7. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover read-only, idempotent, and non-destructive behavior. The description adds substantial behavioral detail beyond that: per-record verdicts, ranking order, cap refusal for limit, exclusion of test/test-support symbols, and which fields each returned entry contains. This is exactly the kind of non-obvious behavior an agent needs to predict results.

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?

The description is longer than average but dense and well-structured, with purpose front-loaded and details organized by record verdicts and removed symbols. The length is justified by the absence of an output schema and the complexity of the report, though a few phrases could be tightened.

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

Completeness5/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 carries the full burden of explaining return values, and it does so thoroughly: verdicts, counts, ranked evidence, per-entry fields, removed_symbols structure, and exclusion rules. An agent has enough information to call the tool and interpret its result without guessing.

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 limit, project, and target_version formats and constraints. The description mostly restates those constraints and adds output semantics rather than new parameter meaning, so the baseline of 3 is appropriate.

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 opens with a concrete question the tool answers: whether a contrib project is ready for a target core version and what work remains. It also names sibling tools for narrower tasks, immediately distinguishing this aggregate readiness report from get_change_record and list_symbol_users.

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?

It explicitly routes readers to get_change_record for one record's detail and to list_symbol_users for a symbol's users, which helps agents choose between tools. It does not enumerate broader exclusion conditions or compare against other readiness-related siblings like check_patches or project_profile, so it stops short of full when-not guidance.

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

All Drupal Code Query toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources