Skip to main content
Glama

lsp-describe_domain

Returns the source-model description of an @ExerisDomain type, including fields, actions, relationships, generated artefacts, and the sourceDigest used as a concurrency token for mutation previews.

Instructions

Return the source-model description of an @ExerisDomain type: fields, actions, relationships, generated artefacts, and the sourceDigest that lsp-preview_mutation takes as its concurrency token.

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": {
      "qualifiedName": "<qualifiedName>"
    },
    "name": "lsp-describe_domain"
  }
}

Input Schema

NameRequiredDescriptionDefault
qualifiedNameYesFully-qualified Java class name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations exist, so the description carries the full burden; it does signal a pure read operation ('Return the ... description') and discloses a non-obvious behavioral contract — that sourceDigest is a concurrency token consumed by lsp-preview_mutation, implying staleness semantics. It does not address failure behavior for unknown or non-@ExerisDomain class names, which keeps it short of a 5.

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?

A single sentence that is front-loaded with the verb and resource, then lists return contents, ending with the cross-tool token relationship. Every clause adds information and nothing is padded.

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?

With no output schema, the description must convey return values and it does so by enumerating the returned sections. For a one-required-parameter read tool this is nearly complete; only lookup-failure behavior and any depth/expansion options are unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: the qualifiedName must identify an '@ExerisDomain type', narrowing the schema's generic 'Fully-qualified Java class name' to a specific domain class. It still doesn't show the expected name format or mention that non-annotated classes will not resolve.

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 names a specific verb ('Return') and resource ('source-model description of an @ExerisDomain type') and enumerates exactly what comes back: fields, actions, relationships, generated artefacts, and sourceDigest. It also positions itself relative to lsp-preview_mutation as the producer of that tool's concurrency token, so an agent can tell what this tool is and is not.

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?

Usage is implied rather than stated: the agent can infer it should call this to inspect a domain's model and to obtain a sourceDigest before calling lsp-preview_mutation. However, it never explicitly says when to prefer this over siblings such as build-get_domain_metadata, lsp-list_domains, or caps-describe_composition, nor does it state any exclusions or prerequisites.

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