Dataverse MCP Server

dataverse_get_custom_api

Read-onlyIdempotent

Get a Dataverse Custom API definition by GUID with its request parameters and response properties expanded.

Instructions

Retrieve a single Custom API record by its GUID, including expanded request parameters and response properties.

Returns all default columns plus:

CustomAPIRequestParameters (customapirequestparameterid, uniquename, name, type, isoptional)
CustomAPIResponseProperties (customapiresponsepropertyid, uniquename, name, type) The @odata.context key is stripped from the response.

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": {
      "params": "<params>"
    },
    "name": "dataverse_get_custom_api"
  }
}

Input Schema

Name	Required	Description	Default
`params`	Yes

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv3.6.0Jul 15, 2026

TDQS

A4/5.0

Behavior4/5

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

Annotations already indicate readOnlyHint=true and destructiveHint=false. The description adds value by specifying that the response includes expanded CustomAPIRequestParameters and CustomAPIResponseProperties, and that @odata.context is stripped. This provides more detail than annotations alone, though it does not discuss authentication or rate limits.

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 concise, with the main purpose stated upfront and additional details in bullet points. Every sentence is informative, and there is no redundant content.

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 tool's simplicity (two required parameters, single record retrieval) and the presence of an output schema, the description provides sufficient context. It explains the expanded fields and a notable transformation (@odata.context stripped). It does not cover potential errors or permissions, but these are standard for such a 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?

The input schema already provides descriptions for both parameters (custom_api_id and dataverse_url). The description does not add new semantic information beyond mentioning 'by its GUID', which is already in the schema. With high schema coverage, baseline score 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 clearly specifies that it retrieves a single Custom API record by GUID and expands request parameters and response properties. It distinguishes from siblings like dataverse_list_custom_apis (which lists all) and dataverse_get_record (which gets any record by table name).

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 usage for fetching a specific Custom API by GUID, but lacks explicit guidance on when to use this tool versus alternatives (e.g., dataverse_list_custom_apis) or when not to use it. No prerequisites or exclusions are mentioned.

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

Deploy Server