Skip to main content
Glama

describe_semantic_entity

Read-only

Retrieve canonical definitions and current states for business entities like Customer, Revenue, or Funnel to maintain consistent data understanding across sessions.

Instructions

Get the canonical definition and state of a business entity (Customer, Revenue, Funnel).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
typeNo

Implementation Reference

  • The handler implementation for the describe_semantic_entity tool, which retrieves schema information from semantic-layer.js and returns entity details.
    case 'describe_semantic_entity': {
      const { describeSemanticSchema } = require('../../scripts/semantic-layer');
      const schema = describeSemanticSchema();
      const entity = schema.entities[args.type] || schema.metrics[args.type];
      if (!entity) {
        throw new Error(`Unknown semantic entity: ${args.type}`);
      }
      return toTextResult(entity);
    }
Behavior3/5

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

Annotations indicate readOnlyHint=true, which the description aligns with by using 'Get' (implying a read operation). The description adds minimal behavioral context beyond annotations, such as specifying the entity types, but does not detail aspects like rate limits, authentication needs, or what 'canonical definition and state' entails. With annotations covering safety, it meets the baseline for adding some value.

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?

The description is a single, efficient sentence that front-loads the core purpose ('Get the canonical definition and state') without unnecessary words. It directly communicates the tool's function, making it highly concise and well-structured for quick understanding.

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

Completeness3/5

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

Given the tool has 1 parameter, readOnlyHint annotation, no output schema, and low schema coverage, the description is adequate but minimal. It covers the basic purpose and parameter semantics but lacks details on usage guidelines, behavioral traits beyond annotations, or output expectations. For a simple read tool, it's viable but has clear gaps in completeness.

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?

The input schema has 1 parameter with an enum (type: Customer, Revenue, Funnel) and 0% schema description coverage. The description mentions the entity types, which adds semantic meaning to the parameter beyond the schema's enum values. However, it does not explain the parameter's role or constraints in detail, so it compensates partially but not fully for the low schema coverage.

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 clearly states the verb ('Get') and resource ('canonical definition and state of a business entity'), specifying the entity types (Customer, Revenue, Funnel). However, it does not explicitly differentiate from sibling tools like 'describe_reliability_entity' or 'get_business_metrics', which might have overlapping purposes, so it falls short of a perfect score.

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?

The description provides no guidance on when to use this tool versus alternatives, such as sibling tools like 'describe_reliability_entity' or 'get_business_metrics'. It lacks context on prerequisites, exclusions, or specific scenarios, offering only a basic functional statement without usage context.

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/IgorGanapolsky/mcp-memory-gateway'

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