Skip to main content
Glama
rededis

dataverse-mcp-server

by rededis

add_entity_key

Create an alternate key on a Dataverse table to enable race-safe upserts or enforce uniqueness beyond the primary key. Supports composite keys; index builds asynchronously.

Instructions

Create an alternate key on a Dataverse table (composite supported via key_attributes). Use for race-safe upserts via keyed-PATCH or to enforce a uniqueness constraint that the primary key doesn't cover. NOTE: Dataverse builds the supporting unique index asynchronously — the key is not usable for keyed lookups until its EntityKeyIndexStatus becomes 'Active'. Poll with list_entity_keys.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
display_nameYesDisplay name for the key
logical_nameYesLogical name of the new key with publisher prefix (e.g. 'contoso_contactproviderkey')
key_attributesYesLogical names of attributes that compose the key (one for a single-column key, multiple for a composite key). Lookups and supported primitive types only — Dataverse rejects keys over Memo, image, or file columns.
entity_logical_nameYesLogical name of the entity
solution_unique_nameNoSolution unique name (defaults to the Default Solution)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.9.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.5.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and delivers meaningful behavior: the unique index is built asynchronously and the key is unusable for keyed lookups until EntityKeyIndexStatus is 'Active'. It omits auth/permission requirements and failure modes (e.g. duplicate data), keeping it from a 5.

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?

Three tight sentences ordered purpose → use cases → critical caveat. The async warning is front-loaded with a NOTE marker, and every sentence carries non-redundant information.

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 mutation tool with no annotations and no output schema, the description supplies the crucial async/lifecycle context and the polling path. It does not address required permissions or how create failures surface, leaving a small gap.

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 coverage is 100%, so all five parameters are already documented in the schema. The description reinforces key_attributes (composite support) but adds no syntax or format detail beyond what the schema provides, so the baseline 3 applies.

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?

Starts with a specific verb+resource ('Create an alternate key on a Dataverse table') and immediately clarifies the composite-key capability. It is clearly distinguishable from siblings like add_attribute, add_picklist_option, and create_relationship, which create different object types.

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?

Explicitly states two use cases ('race-safe upserts via keyed-PATCH' and 'enforce a uniqueness constraint that the primary key doesn't cover') and routes the agent to list_entity_keys for polling. It stops short of an explicit when-not-to-use, so it lands just below the top tier.

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