Skip to main content
Glama

Getcustomdataforentity

getCustomDataForEntity

List all custom data key-value pairs associated with an entity. Retrieve metadata, configuration settings, and custom attributes stored for services, resources, or domains. Supports pagination for entities with large amounts of custom data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYesPage number to return, 0-indexed. Default 0.
contextYes Explain why you're invoking this tool now and how its output will be used. Then state how this call supports your *overall objective* and fits into your broader plan across all tool calls (e.g., why this tool vs. others, and what step it unblocks). Never share any personal details or sensitive information.
tagOrIdYesEntity identifier - can be a tag or CID
pageSizeYesNumber of results to return per page, between 1 and 1000. Default 250.
session_idYesSession continuity handle, one of two values: the ses_ ID issued for the task underway, or start. This server cannot link your calls between requests on its own, so session continuity travels in this parameter instead. If you were handed a session_id for this task — for example by the agent that spawned you — send that exact value from your first call. Otherwise send start on your first call; the server will issue an opaque correlation ID in the mcp_session field of the result, or in a text block at the start of the result beginning [session_id issued. Then send that exact ses_ value on every later call and hand it to any subagents working the same task. start always begins a new, unrelated task — never send it mid-task. If you send a value this server does not recognize, the result reports it: mcp_session.status of unrecognized, or a text block beginning [session_id unrecognized; re-send the ID issued for this task, or start if none was issued yet. Never invent a ses_ value.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / session_id
      Added value: +{
      +  "description": "Session continuity handle, one of two values: the ses_ ID issued for the task underway, or start. This server cannot link your calls between requests on its own, so session continuity travels in this parameter instead. If you were handed a session_id for this task — for example by the agent that spawned you — send that exact value from your first call. Otherwise send start on your first call; the server will issue an opaque correlation ID in the mcp_session field of the result, or in a text block at the start of the result beginning [session_id issued. Then send that exact ses_ value on every later call and hand it to any subagents working the same task. start always begins a new, unrelated task — never send it mid-task. If you send a value this server does not recognize, the result reports it: mcp_session.status of unrecognized, or a text block beginning [session_id unrecognized; re-send the ID issued for this task, or start if none was issued yet. Never invent a ses_ value.",
      +  "pattern": "^(start|ses_[0-9A-Za-z]{27})$",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "tagOrId",
      -  "pageSize",
      -  "page",
      -  "context"
      -]New value: +[
      +  "tagOrId",
      +  "pageSize",
      +  "page",
      +  "session_id",
      +  "context"
      +]
  2. First observed

TDQS

B3.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the behavioral burden. It adds useful context beyond purpose: scoping to services/resources/domains and pagination support for large result sets. However, it does not disclose the return structure (there is no output schema), behavior for empty results, or any ordering/side-effect details; the read-only nature is only inferred from 'List'.

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

Conciseness4/5

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

Three sentences, all of which earn their place: the core action is front-loaded first, the data scope in the second sentence clarifies what 'custom data' means, and the pagination note in the third addresses a real operational concern. No filler or redundancy.

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?

With no output schema and no annotations, the description carries a heavy burden that it only partially meets. It explains the data categories and pagination but never describes what the response looks like, how pages are structured, or what happens with an unknown tagOrId — gaps an agent needs answered before invoking a paginated list tool.

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 all five parameters, including the tricky session_id semantics and pagination defaults. The description adds only general context about what the data contains, not per-parameter meaning beyond the schema, so it neither needs to compensate nor adds much.

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 states a specific action ('List all custom data key-value pairs') and resource ('an entity'), and elaborates on the data kinds covered (metadata, configuration settings, custom attributes). It does not explicitly differentiate itself from siblings like getCustomDataForEntityByKey or retrieveCustomDataForEntityAdvanced, though 'all ... key-value pairs' implies the contrast with key-specific lookup.

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?

There is no explicit when-to-use guidance or naming of alternatives, despite many similarly scoped siblings (getCustomDataForEntityByKey, retrieveCustomDataForEntityAdvanced, getCustomEventForEntityByUuid). Usage is only implied by the phrase 'List all ... key-value pairs', which leaves an agent guessing which custom-data tool to pick among the overlapping set.

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.

Resources