Skip to main content
Glama

Open Footprint: get entity definition

ofp_entity
Read-onlyIdempotent

Use this when you need one entity's fields, types, keys and relationships, for example to design a table or an API payload.

Pass domain when known: ambiguous names fail rather than guessing (ofp_models reports ambiguousNameCount).

Input Schema

NameRequiredDescriptionDefault
nameYes
domainNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedInput schema / properties / domain / description
      Removed value: -"Model domain, e.g. \"Product Life Cycle\""
    • removedInput schema / properties / name / description
      Removed value: -"Entity name, e.g. \"Product Carbon Footprint\""
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish the safe-read profile (readOnly, idempotent, non-destructive, closed-world), so the description's job is to add operational detail — which it does by disclosing that ambiguous names fail rather than guessing and by pointing to ofp_models for ambiguousNameCount. That is genuine failure-mode disclosure well beyond the annotations, though it says nothing about response shape or lookup cost.

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?

Two short sentences, front-loaded with the trigger condition, and every clause carries information the agent cannot get from the schema or annotations. No filler.

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 correctly previews the return contents (fields, types, keys, relationships) and covers the main failure mode. It falls short of complete because the required name parameter's semantics and the relationship to sibling lookups (search, semantic code) are left unstated for a tool in a crowded namespace.

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 full burden for two parameters. It explains why domain matters (disambiguation) but says nothing about its expected form or scope (domain id vs. name), and leaves the required name parameter entirely implicit.

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 names a specific resource and payload: one entity's fields, types, keys and relationships, plus a concrete use case (designing a table or API payload). It implicitly contrasts with broader lookups by emphasizing 'one entity', but never names a sibling such as ofp_search_entities or ofp_semantic_code, so the differentiation is inferential rather than explicit.

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

Usage Guidelines4/5

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

It gives a clear trigger condition ('when you need one entity's fields...') and a conditional rule for the optional domain parameter ('Pass domain when known'). What is missing is an explicit statement of when NOT to use it or which sibling to reach for instead when the entity name is unknown.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.