Skip to main content
Glama

bx_project_get

Read-onlyIdempotent

Read exact project revision metadata, source digests, and artifact references for a specified project. Requires an explicit revision with no latest fallback, ensuring precise, traceable state.

Instructions

读取指定项目的精确版本及完整内容引用。 / Read exact project revision metadata, source digests and artifact references. Revision required; no latest fallback.

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": {
      "project_id": "<project_id>",
      "revision": "<revision>"
    },
    "name": "bx_project_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
revisionYes
project_idYes

Output Schema

NameRequiredDescriptionDefault
dataYes
kindYes
productYes
api_versionYes
business_decisionYes
execution_authorizationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0-rc.9-linux.1

TDQS

A3.7/5.0
Behavior4/5

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

The annotations already establish read-only, idempotent, closed-world behavior, and the description adds the important operational constraint that a revision must be supplied with no fallback. It also hints at the payload contents (source digests, artifact references), which goes beyond what the annotations state.

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 short sentences, front-loaded with the resource and followed immediately by the key constraint. The bilingual duplication doubles the text length, though that appears to be a deliberate convention rather than padding.

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?

An output schema exists, so return-value details needn't be described, and annotations cover the safety profile. What remains is the revision-required rule, which is stated clearly; only error behavior for a nonexistent revision 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?

Schema description coverage is 0%, so the description carries the burden; it clarifies that revision selects an exact pin rather than a latest pointer, which is meaningful beyond the schema's bare integer. The project_id parameter gets no semantic explanation, though its UUID pattern is fully expressed in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource: read project revision metadata, source digests and artifact references. The phrase 'exact project revision' and 'no latest fallback' distinguish it from list-style siblings such as bx_projects_list, although no sibling is named explicitly.

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

Usage Guidelines3/5

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

'Revision required; no latest fallback' is a real usage constraint that tells the agent not to attempt a latest-version shortcut. However, it gives no guidance on when to call this versus bx_projects_list for discovery or bx_artifact_get for a single artifact, so alternatives remain implicit.

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