Skip to main content
Glama
us-all

openmetadata-mcp-server

by us-all

get-domain

Retrieve domain details by UUID. Optionally specify fields to include and filter by deletion status.

Instructions

Get domain details by UUID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDomain UUID
fieldsNoComma-separated fields to include
includeNo

Implementation Reference

  • The handler function for the get-domain tool. Extracts the domain UUID from params, calls the OpenMetadata API endpoint GET /domains/{id} with optional query parameters.
    export async function getDomain(params: z.infer<typeof getDomainSchema>) {
      const { id, ...query } = params;
      return omClient.get(`/domains/${id}`, query);
    }
  • Zod schema for get-domain input validation. Requires 'id' (UUID string), optional 'fields' and 'include' parameters.
    export const getDomainSchema = z.object({
      id: z.string().describe("Domain UUID"),
      fields: z.string().optional().describe("Comma-separated fields to include"),
      include: z.enum(["non-deleted", "deleted", "all"]).optional(),
    });
  • src/index.ts:337-337 (registration)
    Registers the get-domain tool with the MCP server. Associates the schema and handler, and applies category-based filtering (OM_TOOLS/OM_DISABLE) for the 'domains' category.
    tool("get-domain", "Get domain details by UUID", getDomainSchema.shape, wrapToolHandler(getDomain));
  • The tool registration helper that wraps each MCP tool registration. It registers the tool in a registry (for category filtering) and conditionally binds it to the MCP server if the current category is enabled.
    function tool(name: string, description: string, schema: any, handler: any): void {
      registry.register(name, description, currentCategory);
      if (registry.isEnabled(currentCategory)) {
        server.tool(name, description, schema, handler);
      }
    }
Behavior2/5

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

No annotations are provided, so the description carries full responsibility for behavioral disclosure. It only states 'Get domain details', which implies a read operation but does not mention safety, authentication, rate limits, or side effects. For a read tool with no annotations, the description lacks behavioral context.

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

Conciseness3/5

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

The description is a single sentence, which is concise. However, it essentially restates the tool name without adding significant value. While brevity is positive, the description could be slightly more informative without losing conciseness.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple nature of the tool (3 parameters, no output schema, no annotations), the description is too minimal. It does not explain what 'domain details' includes, how the 'include' filter works, or what the return value looks like. The description leaves gaps for a complete understanding.

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

Parameters2/5

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

The input schema has 67% description coverage (id and fields have descriptions, include does not). The tool description adds no information about parameters beyond what is in the schema. It does not explain the fields parameter or the include enum values, leaving the agent to rely solely on 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 ('Get') and resource ('domain details') with a clear retrieval criterion ('by UUID'). It distinguishes from siblings like 'get-domain-by-name' (which uses name) and 'get-domain-summary' (which returns summary), though it doesn't explicitly name alternatives. The purpose is clear but could be more explicit about differentiation.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. The description does not mention prerequisites, exclusions, or scenarios where another tool is preferred. An agent must infer from the tool name and context, which is insufficient.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/us-all/openmetadata-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server