dataverse-mcp-server

list_entity_keys

Retrieve alternate keys defined on a Dataverse table and check each key's index build status to confirm whether it is Active and ready 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "entity_logical_name": "<entity_logical_name>"
    },
    "name": "list_entity_keys"
  }
}

Input Schema

Name	Required	Description	Default
`entity_logical_name`	Yes	Logical name of the entity

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.9.0Oct 3, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

First observedv0.5.0Jul 31, 2026

TDQS

A4/5.0

Behavior4/5

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

No annotations, so the description carries the burden, and it adds real behavioral context: the returned fields and crucially that alt keys are not usable until index status is Active. It doesn't cover auth/permissions or whether this is a safe read (implicitly read-only by name), so short of full disclosure.

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 tight sentences, front-loaded with purpose, then return shape, then the critical index-status caveat. 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?

For a one-param read tool with no output schema, it adequately describes the return array and a key operational constraint. Missing only error/edge-case behavior (e.g., unknown table) and explicit read-only assurance.

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% with a single well-documented parameter, so baseline is 3. The description adds no extra syntax or format detail for entity_logical_name beyond what the schema provides.

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?

Specific verb+resource: 'List alternate keys defined on a Dataverse table', with a precise return shape. Distinguishes from siblings like get_entity_schema or list_entities by naming the exact sub-resource (alternate keys).

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?

Implied usage (inspect keys before composing a keyed-PATCH upsert), but no explicit when-to-use vs alternatives such as get_entity_schema or add_entity_key. The index-status note hints at a precondition but doesn't state how or when to call this tool.

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