AI导哈

PowerPlatform Dataverse 环境管理与配置工具

为 AI 客户端和命令行用户提供 PowerPlatform / Dataverse 环境的查询与配置能力，涵盖实体、记录、插件、流程、解决方案、安全角色等资源的读取与自动化操作。

  • by michsob
  • TypeScript
  • 本地部署
  • 44 星标
  • 更新于
在 GitHub 查看 michsob/powerplatform-mcp

使用说明

PowerPlatform MCP / CLI

A Model Context Protocol (MCP) server and standalone CLI for querying and configuring PowerPlatform / Dataverse environments. Supports multiple environments, entity metadata, records, plugins, flows, solutions, workflows, business rules, security roles, custom APIs, web resources, and more — including write operations for automated environment setup.

Why MCP + CLI?

MCP integrates directly with AI clients (Claude, Cursor, GitHub Copilot) for interactive, conversational exploration of your environments.

CLI writes results to a file system cache instead of returning them inline. MCP tool responses are bound by the AI client's context window, which can truncate or degrade results when querying environments with hundreds of entities, flows, or plugin steps. The CLI avoids this limitation by persisting full results to disk, making them available for follow-up analysis without context pressure. Both interfaces share the same tools and capabilities.

Installation

Requires Node.js 22+ (< 25).

MCP Server

npm install -g powerplatform-mcp
# or
npx powerplatform-mcp

CLI

npm install -g powerplatform-cli
# or
npx powerplatform-cli

Docker

# MCP Server
docker pull ghcr.io/michsob/powerplatform-mcp
docker run --env-file .env ghcr.io/michsob/powerplatform-mcp

# CLI
docker pull ghcr.io/michsob/powerplatform-cli
docker run --env-file .env ghcr.io/michsob/powerplatform-cli entity-attributes account

Configuration

The tool supports multiple environments. Define them via environment variables:

POWERPLATFORM_ENVIRONMENTS=DEV,UAT,PROD

# For each environment, set:
POWERPLATFORM_DEV_URL=https://dev-org.crm.dynamics.com
POWERPLATFORM_DEV_CLIENT_ID=your-client-id
POWERPLATFORM_DEV_CLIENT_SECRET=your-client-secret
POWERPLATFORM_DEV_TENANT_ID=your-tenant-id

POWERPLATFORM_UAT_URL=https://uat-org.crm.dynamics.com
POWERPLATFORM_UAT_CLIENT_ID=...
POWERPLATFORM_UAT_CLIENT_SECRET=...
POWERPLATFORM_UAT_TENANT_ID=...

For local development, copy .env.example to .env and fill in your credentials.

MCP Server

The MCP server is designed for AI-powered clients (Claude, Cursor, GitHub Copilot).

Available MCP Tools (67)

All tools accept an optional environment parameter to target a specific environment (defaults to the first configured).

Entity

Tool Description Required Params Optional
get-entity-metadata Get entity metadata entityName
get-entity-attributes List all attributes/fields entityName
get-entity-attribute Get a specific attribute entityName, attributeName
get-entity-relationships Get 1:N and N:N relationships entityName
create-entity-string-attribute Create a Single Line of Text column entityName, schemaName, displayName maxLength, requiredLevel, description, solutionName
get-entity-keys List alternate keys on an entity entityName
create-entity-alternate-key Create an alternate key entityName, schemaName, displayName, keyAttributes solutionName

Records

Tool Description Required Params Optional
get-record Get a record by ID entityNamePlural, recordId
query-records OData query entityNamePlural, filter maxRecords (default 50)

Plugins

Tool Description Required Params Optional
get-plugin-assemblies List plugin assemblies includeManaged, maxRecords
get-plugin-assembly-complete Assembly with types, steps, images assemblyName includeDisabled
get-entity-plugin-pipeline Plugins executing on an entity entityName messageFilter, includeDisabled
get-plugin-trace-logs Plugin trace logs entityName, messageName, correlationId, pluginStepId, exceptionOnly, hoursBack, maxRecords
get-all-plugin-steps All SDK message processing steps includeDisabled, maxRecords
get-plugin-type Look up a plugin type by class name typeName
get-sdk-message Look up an SDK message by name messageName
create-plugin-step Register a plugin step name, pluginTypeId, sdkMessageId, stage, mode rank, supportedDeployment, description, configuration, sdkMessageFilterId, solutionName

Flows (Power Automate)

Tool Description Required Params Optional
get-flows List cloud flows (smart filtering) activeOnly, maxRecords, nameContains, excludeSystem, excludeCustomerInsights, excludeCopilotSales
search-workflows Search workflows and flows name, primaryEntity, description, category, statecode, includeDescription, maxResults
get-flow-definition Full definition or parsed summary flowId summary
get-flow-runs Flow run history flowId status, startedAfter, startedBefore, maxRecords
get-flow-run-details Run details with action-level errors flowId, runId
cancel-flow-run Cancel a running/waiting run flowId, runId
resubmit-flow-run Retry a failed run flowId, runId
scan-flow-health Batch health scan (success rates) daysBack, maxRunsPerFlow, maxFlows, activeOnly
get-flow-inventory Lightweight flow inventory maxRecords

Solutions

Tool Description Required Params Optional
get-publishers List non-readonly publishers
get-solutions List visible solutions
get-solution Get solution by unique name uniqueName
get-solution-components List components in a solution solutionUniqueName
export-solution Export solution (base64) solutionName managed
add-solution-component Add a component to a solution solutionUniqueName, componentId, componentType addRequiredComponents
publish-customizations Publish entity or all customizations entityLogicalName

Workflows (Classic)

Tool Description Required Params Optional
get-workflows List classic workflows activeOnly, maxRecords
get-workflow-definition XAML definition or summary workflowId summary
get-ootb-workflows Background, BPFs, actions, on-demand maxRecords, categories

Business Rules

Tool Description Required Params Optional
get-business-rules List business rules activeOnly, maxRecords
get-business-rule Business rule with XAML workflowId

Option Sets

Tool Description Required Params
get-global-option-set Get a global option set definition optionSetName

Configuration

Tool Description Required Params Optional
get-connection-references Connection references maxRecords, managedOnly, hasConnection, inactive
get-environment-variables Environment variable definitions + values maxRecords, managedOnly
create-environment-variable Create an environment variable definition schemaName, displayName, type defaultValue, description, solutionName
set-environment-variable-value Set or update an environment variable value definitionId, value existingValueId

Custom APIs

Tool Description Required Params Optional
get-custom-apis List Custom API definitions maxRecords, includeManaged
get-custom-api Get a Custom API by unique name uniqueName
create-custom-api Create a Custom API definition uniqueName, name, displayName, bindingType, isFunction, isPrivate, allowedCustomProcessingStepType description, pluginTypeId, pluginTypeName, boundEntityLogicalName, solutionName
get-custom-api-response-properties List response properties customApiId
create-custom-api-response-property Create a response property customApiId, uniqueName, name, displayName, type description, logicalEntityName, isOptional, solutionName
get-custom-api-request-parameters List request parameters customApiId
create-custom-api-request-parameter Create a request parameter customApiId, uniqueName, name, displayName, type description, logicalEntityName, isOptional, solutionName

Web Resources

Tool Description Required Params Optional
get-web-resources List web resources maxRecords, webResourceType, nameFilter
get-web-resource Get a web resource by name name
create-web-resource Upload a new web resource name, displayName, webResourceType, content description, solutionName

Security Roles

Tool Description Required Params Optional
get-security-roles List customizable security roles solutionUniqueName, excludeSystemRoles, includePrivileges, maxRecords
get-security-role-privileges Privileges for a role (name, accessright, depth mask) roleId entityFilter, accessRightFilter
list-privileges Browse the system privilege catalog to discover privilegeId GUIDs and supported depths entityFilter, accessRightFilter, maxRecords
create-security-role Create a new role (defaults to root BU); optional solutionUniqueName adds it to a solution in one step name businessUnitId, description, solutionUniqueName
clone-security-role Clone a role with its privileges. Uses CloneAsRole with a create-then-copy fallback when the action isn't available sourceRoleId newName, targetBusinessUnitId, solutionUniqueName
update-security-role Update a role's name, description, or business unit roleId name, description, businessUnitId, solutionUniqueName
delete-security-role Delete a role (destructive — requires confirm: true) roleId, confirm
add-security-role-privileges Append privileges to a role (AddPrivilegesRole — leaves existing privileges intact) roleId, privileges[]
remove-security-role-privileges Remove privileges from a role (loops RemovePrivilegeRole) roleId, privilegeIds[]
replace-security-role-privileges Wipe and replace the full privilege set (ReplacePrivilegesRole — destructive, requires confirm: true) roleId, privileges[], confirm

Each item in privileges[] is { privilegeId, depth, businessUnitId? }. Depth is one of Basic (user), Local (BU), Deep (BU + child), Global (org).

Dependencies

Tool Description Required Params
check-component-dependencies Dependencies blocking deletion componentId, componentType
check-delete-eligibility Check if a component can be deleted componentId, componentType

Service Endpoints

Tool Description Optional
get-service-endpoints Service Bus, webhooks, Event Hub, Event Grid maxRecords

MCP Prompts

Prompt Description Required Args
entity-overview Entity overview with key attributes and relationships entityName
attribute-details Detailed attribute info (type, format, requirements) entityName, attributeName
query-template OData query template with example filters entityName
relationship-map Complete 1:N and N:N relationship map entityName

CLI

Same tools as the MCP server, but results are cached to the file system for full-fidelity output on large data sets.

Global Option

--env <name> — target environment (defaults to first configured).

Commands

Entity

entity-metadata <entityName>
entity-attributes <entityName>
entity-attribute <entityName> <attributeName>
entity-relationships <entityName>
entity-keys <entityName>
create-entity <schemaName> <displayName> <displayCollectionName>  [--primary-name-schema <name>] [--primary-name-display <name>] [--description <desc>] [--ownership <UserOwned|OrganizationOwned>] [--has-activities] [--has-notes] [--solution <name>]
create-entity-string-attribute <entityName> <schemaName> <displayName>  [--max-length <n>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-memo-attribute <entityName> <schemaName> <displayName>  [--max-length <n>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-file-attribute <entityName> <schemaName> <displayName>  [--max-size-kb <n>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-integer-attribute <entityName> <schemaName> <displayName>  [--min <n>] [--max <n>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-decimal-attribute <entityName> <schemaName> <displayName>  [--precision <n>] [--min <n>] [--max <n>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-money-attribute <entityName> <schemaName> <displayName>  [--precision-source <0|1|2>] [--precision <n>] [--min <n>] [--max <n>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-boolean-attribute <entityName> <schemaName> <displayName>  [--true-label <label>] [--false-label <label>] [--default-value <true|false>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-datetime-attribute <entityName> <schemaName> <displayName>  [--format <DateOnly|DateAndTime>] [--behavior <UserLocal|DateOnly|TimeZoneIndependent>] [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-picklist-attribute <entityName> <schemaName> <displayName>  [-o <value:label>]... [--required-level <level>] [--description <desc>] [--solution <name>]
create-entity-lookup <referencingEntity> <referencedEntity> <relationshipSchemaName> <lookupSchemaName> <displayName>  [--required-level <level>] [--description <desc>] [--cascade-delete <NoCascade|RemoveLink|Restrict|Cascade>] [--solution <name>]
create-entity-alternate-key <entityName> <schemaName> <displayName> <keyAttributes...>  [--solution <name>]
delete-entity-attribute <entityName> <attributeName>

Records

record <entityNamePlural> <recordId>
query-records <entityNamePlural> <filter>  [--max <n>]
create-record <entityNamePlural> <jsonBody>
update-record <entityNamePlural> <recordId> <jsonBody>
delete-record <entityNamePlural> <recordId>
associate-records <entityNamePlural> <recordId> <navigationProperty> <relatedEntityNamePlural> <relatedRecordId>
disassociate-records <entityNamePlural> <recordId> <navigationProperty> [relatedRecordId]

Plugins

plugin-assemblies                          [--include-managed] [--max <n>]
plugin-assembly <assemblyName>             [--include-disabled]
plugin-packages                            [--include-managed] [--max <n>]
plugin-type <typeName>
entity-pipeline <entityName>               [--message <msg>] [--include-disabled]
plugin-trace-logs                          [--entity <name>] [--message <msg>] [--correlation-id <id>] [--step-id <id>] [--hours <n>] [--max <n>] [--exceptions-only]
all-plugin-steps                           [--include-disabled] [--max <n>]
sdk-message <messageName>
register-plugin-package <filePath>         [--pkg-version <version>] [--solution <name>]
update-plugin-package <filePath>           --plugin-package-id <id> [--pkg-version <version>]
create-plugin-step <name> <pluginTypeId> <sdkMessageId>  [--stage <n>] [--mode <n>] [--rank <n>] [--supported-deployment <n>] [--description <desc>] [--configuration <cfg>] [--message-filter-id <id>] [--solution <name>]
create-plugin-step-image <stepId>          [--name <name>] [--entity-alias <alias>] [--image-type <0|1|2>] [--message-property-name <name>] [--attributes <csv>]

Flows

flows                                      [--active] [--name <contains>] [--include-managed] [--max <n>]
flow-definition <flowId>                   [--summary]
flow-inventory                             [--max <n>]
flow-runs <flowId>                         [--status <s>] [--after <iso>] [--before <iso>] [--max <n>]
flow-run-details <flowId> <runId>
flow-health                                [--days <n>] [--max-runs <n>] [--max-flows <n>] [--active]
search-workflows                           [--name <name>] [--entity <entity>] [--category <n>] [--active] [--max <n>]
create-cloud-flow <clientDataFile>         [--primary-entity <entity>] [--solution <name>]
activate-flow <flowId>
deactivate-flow <flowId>

Solutions

solutions
solution <uniqueName>
solution-components <uniqueName>
publishers
add-solution-component <solutionUniqueName> <componentId> <componentType>  [--add-required]
publish-customizations                     [--entity <logicalName>]

Workflows

workflows                                  [--active] [--max <n>]
workflow-definition <workflowId>           [--summary]
ootb-workflows                             [--categories <0,1,2,3,4>]

Business Rules

business-rules                             [--active] [--max <n>]
business-rule <workflowId>

Option Sets

optionset <optionSetName>

Dependencies

check-dependencies <componentId> <componentType>

Configuration

connection-references                      [--managed-only] [--has-connection] [--no-connection] [--inactive] [--max-records <n>]
create-connection-reference <logicalName> <displayName> <connectorId>  [--description <desc>] [--solution <name>]
environment-variables                      [--managed-only] [--max-records <n>]
create-environment-variable <schemaName> <displayName>  [--type <type>] [--default-value <val>] [--description <desc>] [--solution <name>]
set-environment-variable-value <definitionId> <value>   [--existing-value-id <id>]

Custom APIs

custom-apis                                [--include-managed] [--max <n>]
custom-api <uniqueName>
create-custom-api <uniqueName> <displayName>  [--binding-type <n>] [--bound-entity <name>] [--is-function] [--is-private] [--processing-type <n>] [--plugin-type-id <id>] [--plugin-type-name <name>] [--description <desc>] [--solution <name>]
custom-api-response-properties <customApiId>
create-custom-api-response-property <customApiId> <uniqueName> <displayName>  [--type <n>] [--description <desc>] [--solution <name>]
custom-api-request-parameters <customApiId>
create-custom-api-request-parameter <customApiId> <uniqueName> <displayName>  [--type <n>] [--description <desc>] [--optional] [--solution <name>]

Web Resources

web-resources                              [--type <n>] [--name <contains>] [--max <n>]
web-resource <name>
create-web-resource <name> <displayName> <filePath>  [--type <n>] [--description <desc>] [--solution <name>]
set-entity-icon <entityName> <svgFilePath>  [--solution <name>] [--web-resource-name <name>] [--display-name <name>] [--no-publish]

Forms & Views

entity-forms <entityName>                  [--type <n>]
entity-form-fields <formId>
add-form-field <entityName> <formId> <attributeName>
remove-form-field <entityName> <formId> <attributeName>
entity-views <entityName>
add-view-column <entityName> <viewId> <attributeName>   [--width <n>]
set-view-columns <entityName> <viewId> <columns...>     [--order-by <attr>] [--desc]
remove-view-column <entityName> <viewId> <attributeName>

PAC Integration

pac-auth                                   Authenticate pac CLI using environment credentials
generate-models <outdirectory>             [--settings <path>] [--entities <filter>] [--namespace <ns>]
deploy-plugin <pluginFile>                 --plugin-id <id> [--type <Nuget|Assembly>] [--configuration <config>]

Security Roles

security-roles                             [--solution <name>] [--include-system] [--include-privileges] [--max-records <n>]
security-role-privileges <roleId>          [--entity <name>] [--access-right <type>]
privileges                                 [--entity <name>] [--access-right <type>] [--max-records <n>]
create-security-role                       --name <name> [--bu <id>] [--description <desc>] [--solution <name>]
clone-security-role <sourceRoleId>         [--name <name>] [--target-bu <id>] [--solution <name>]
update-security-role <roleId>              [--name <name>] [--description <desc>] [--bu <id>] [--solution <name>]
delete-security-role <roleId>              --yes
add-role-privileges <roleId>               --privileges <spec>     # JSON array or shorthand <guid>:<Basic|Local|Deep|Global>,...
remove-role-privileges <roleId>            --privileges <id,id,id>
replace-role-privileges <roleId>           --privileges <spec> --yes

Service Endpoints

service-endpoints                          [--max <n>]

Development

git clone https://github.com/michsob/powerplatform-mcp.git
cd powerplatform-mcp
npm install
cp .env.example .env   # fill in credentials
npm run build
npm run inspector      # test with MCP Inspector

Releasing

To publish a new version:

  1. Update version in package.json
  2. Commit the change to main
  3. Create and push a version tag:
    git tag v1.0.2
git push origin v1.0.2

GitHub Actions will automatically publish:

Package npm GitHub Packages Docker (GHCR)
MCP Server npm i powerplatform-mcp npm i @michsob/powerplatform-mcp ghcr.io/michsob/powerplatform-mcp
CLI npm i powerplatform-cli npm i @michsob/powerplatform-cli ghcr.io/michsob/powerplatform-cli

npm publishing uses Trusted Publishing (OIDC) — no tokens or secrets needed. GitHub Packages and GHCR use the built-in GITHUB_TOKEN automatically.

License

MIT

相关 MCP