Skip to main content
Glama
qase-tms

Qase MCP Server

Official
by qase-tms

Get record

qase_get
Read-onlyIdempotent

Fetch a single Qase record by entity type and ID when you already know its identifier. Use it for one specific case, suite, run, defect, or similar record.

Instructions

Fetch one known record by type and ID — case, suite, run, result, plan, defect, milestone, environment, shared_step, review, custom_field and more. Use it only when you already have the ID and want that one record; for several, anything filtered, or a loop over IDs, use qql_search — one search returns the whole page. Cost: one API call, 0.3-0.5s; ten in sequence measured 5.3s against 1.2s for one qql_search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesEntity ID (number) or hash (string)
codeNoProject code (required for most entities)
entityYesEntity type to fetch
fieldsNoOptional field projection — only return these top-level fields. Pass ["*"] for all fields.
includeNoComma-separated list of related entities to include in the response. Cases and runs already request their external issue links by default ("external_issues" / "external_issue"); pass this only to override that.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv3.0.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / id / anyOf
      Previous value: -[
      -  {
      -    "description": "Entity ID (positive integer)",
      -    "exclusiveMinimum": 0,
      -    "type": "integer"
      -  },
      -  {
      -    "description": "Hash identifier",
      -    "maxLength": 255,
      -    "minLength": 1,
      -    "type": "string"
      -  }
      -]New value: +[
      +  {
      +    "description": "Entity ID",
      +    "exclusiveMinimum": 0,
      +    "type": "integer"
      +  },
      +  {
      +    "description": "Hash identifier",
      +    "maxLength": 255,
      +    "minLength": 1,
      +    "type": "string"
      +  }
      +]
  2. Changed1 schema field changedv2.2.1
    • changedInput schema / properties / entity / enum
      Previous value: -[
      -  "case",
      -  "suite",
      -  "run",
      -  "result",
      -  "plan",
      -  "defect",
      -  "milestone",
      -  "environment",
      -  "shared_step",
      -  "shared_parameter",
      -  "configuration",
      -  "attachment",
      -  "author",
      -  "user",
      -  "custom_field"
      -]New value: +[
      +  "case",
      +  "suite",
      +  "run",
      +  "result",
      +  "plan",
      +  "defect",
      +  "milestone",
      +  "environment",
      +  "shared_step",
      +  "shared_parameter",
      +  "configuration",
      +  "attachment",
      +  "author",
      +  "user",
      +  "review",
      +  "custom_field"
      +]
  3. Changed1 schema field changedv2.0.3
    • addedInput schema / properties / include
      Added value: +{
      +  "description": "Comma-separated list of related entities to include in the response. Cases and runs already request their external issue links by default (\"external_issues\" / \"external_issue\"); pass this only to override that.",
      +  "type": "string"
      +}
  4. Addedv2.0.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description goes beyond them with measured cost/latency data ('one API call, 0.3-0.5s; ten in sequence measured 5.3s against 1.2s for one qql_search') plus a default-behavior note about external issue links. This is genuine behavioral context an agent can use for batching decisions.

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

Conciseness5/5

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

Front-loaded with the core action, then the routing exclusion, then the cost rationale. Three sentences, no filler, and the most decision-relevant information (when to pick qql_search) appears early.

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 read tool with no output schema, the description covers invocation and routing well, and the schema handles parameters exhaustively. Its one gap is that it doesn't characterize the returned payload shape at all, which matters slightly more given there is no output schema to fall back on.

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 baseline is 3 and the schema already documents id/code/fields/include in detail. The description restates entity types and the ID-lookup notion but adds no syntax or format detail beyond what the schema provides.

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?

Specific verb + resource + scope: 'Fetch one known record by type and ID', followed by an enumeration of entity types. It also explicitly distinguishes itself from the sibling qql_search, so an agent can route correctly without opening either schema.

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

Usage Guidelines5/5

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

States the precise precondition ('only when you already have the ID') and the disallowed cases ('for several, anything filtered, or a loop over IDs, use qql_search'), naming the alternative tool. This is exactly the when/when-not/alternative structure the dimension rewards.

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