Skip to main content
Glama
rededis

dataverse-mcp-server

by rededis

list_entity_keys

Lists alternate keys for a Dataverse table, showing key attributes and index status (Pending, Active, Failed) to determine readiness for keyed PATCH upserts.

Instructions

List alternate keys defined on a Dataverse table. Returns a flat array of { logical_name, schema_name, display_name, key_attributes, entity_key_index_status, metadata_id }. entity_key_index_status reflects the background index build (Pending → Active, or Failed) — alt keys are not usable for keyed-PATCH upserts until Active.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_logical_nameYesLogical name of the entity
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses the return format (flat array of fields) and adds significant context about entity_key_index_status reflecting a background index build (Pending → Active, or Failed) and that keys are not usable for keyed-PATCH upserts until Active. This goes beyond a basic listing description.

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 two sentences, front-loaded with the primary purpose, and the second sentence efficiently adds valuable behavioral context. No wasted words.

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?

Given the low complexity (one simple parameter, no output schema, no annotations), the description is quite complete. It covers the action, return fields, and a key behavioral nuance. It could mention error handling or pagination, but for a list tool of this simplicity, it is sufficiently complete.

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 schema already documents the sole parameter 'entity_logical_name' with a clear description. The tool description does not add any parameter-specific meaning beyond what the schema provides. With 100% schema coverage, the baseline of 3 is appropriate.

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 uses a specific verb 'List' and clearly states the resource ('alternate keys') and scope ('on a Dataverse table'). It distinguishes itself from sibling tools like add_entity_key/delete_entity_key by focusing on listing rather than mutation.

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?

The description implies when to use the tool (whenever you need to list alternate keys) but does not explicitly name alternatives or provide exclusions. It lacks guidance such as 'for creating or deleting keys, use add_entity_key/delete_entity_key'.

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/rededis/dataverse-mcp-server'

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