-
Notifications
You must be signed in to change notification settings - Fork 4k
New dataverse-mcp plugin with mcp-setup command #781
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
c7bc853
New dataverse-mcp plugin with mcp-setup command
lupritz c7b9c54
Rename plugin from dataverse-mcp to just dataverse
lupritz f36e6e4
Minor prompt rename
lupritz b63a0e4
Minor prompt rename
lupritz 0912206
Merge branch 'staged' into addDataverseMcpInstaller
lupritz 98c6c1c
Merge conflict
lupritz 1bad087
Merge branch 'staged' into addDataverseMcpInstaller
lupritz 03fcbc8
Convert mcp-setup command to mcp-configure skill
lupritz a629773
Merge branch 'staged' into addDataverseMcpInstaller
lupritz e30f35d
Merge branch 'staged' into addDataverseMcpInstaller
lupritz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "name": "dataverse", | ||
| "description": "Comprehensive collection for Microsoft Dataverse integrations. Includes MCP setup commands.", | ||
| "version": "1.0.0", | ||
| "author": { | ||
| "name": "Awesome Copilot Community" | ||
| }, | ||
| "repository": "https://github.com/github/awesome-copilot", | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| "dataverse", | ||
| "mcp" | ||
| ], | ||
| "commands": [ | ||
| "./commands/mcp-setup.md" | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Dataverse MCP | ||
|
|
||
| Comprehensive collection for Microsoft Dataverse integrations. Includes MCP setup commands that guide you through configuring Dataverse MCP servers for GitHub Copilot. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| # Using Copilot CLI | ||
| copilot plugin install dataverse@awesome-copilot | ||
| ``` | ||
|
|
||
| ## What's Included | ||
|
|
||
| ### Commands (Slash Commands) | ||
|
|
||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `/dataverse:mcp-setup` | Configure Dataverse MCP server for GitHub Copilot with global or project-scoped settings. No external scripts required. | | ||
|
|
||
| ## Source | ||
|
|
||
| This plugin is part of [Awesome Copilot](https://github.com/github/awesome-copilot), a community-driven collection of GitHub Copilot extensions. | ||
|
|
||
| ## License | ||
|
|
||
| MIT |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| --- | ||
| name: mcp setup | ||
| description: Configure an MCP server for GitHub Copilot with your Dataverse environment. | ||
| --- | ||
|
|
||
| # Setup Dataverse MCP for GitHub Copilot | ||
|
|
||
| This skill configures the Dataverse MCP server for GitHub Copilot with your organization's environment URL. Each organization is registered with a unique server name based on the org identifier (e.g., `DataverseMcporgbc9a965c`). If the user provided a URL it is: $ARGUMENTS. | ||
|
|
||
| ## Instructions | ||
|
|
||
| ### 0. Ask for MCP scope | ||
|
|
||
| Ask the user whether they want to configure the MCP server globally or for this project only: | ||
|
|
||
| > Would you like to configure the Dataverse MCP server: | ||
| > 1. **Globally** (available in all projects) | ||
| > 2. **Project-only** (available only in this project) | ||
|
|
||
| Based on their choice, set the `CONFIG_PATH` variable: | ||
| - **Global**: `~/.copilot/mcp-config.json` (use the user's home directory) | ||
| - **Project**: `.mcp/copilot/mcp.json` (relative to the current working directory) | ||
|
|
||
| Store this path for use in steps 1 and 6. | ||
|
|
||
| ### 1. Check already-configured MCP servers | ||
|
|
||
| Read the MCP configuration file at `CONFIG_PATH` (determined in step 0) to check for already-configured servers. | ||
|
|
||
| The configuration file is a JSON file with the following structure: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "ServerName1": { | ||
| "type": "http", | ||
| "url": "https://example.com/api/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Or it may use `"servers"` instead of `"mcpServers"` as the top-level key. | ||
|
|
||
| Extract all `url` values from the configured servers and store them as `CONFIGURED_URLS`. For example: | ||
|
|
||
| ```json | ||
| ["https://orgfbb52bb7.crm.dynamics.com/api/mcp"] | ||
| ``` | ||
|
|
||
| If the file doesn't exist or is empty, treat `CONFIGURED_URLS` as empty (`[]`). This step must never block the skill. | ||
|
|
||
| ### 2. Ask how to get the environment URL | ||
|
|
||
| Ask the user: | ||
|
|
||
| > How would you like to provide your Dataverse environment URL? | ||
| > 1. **Auto-discover** — List available environments from your Azure account (requires Azure CLI) | ||
| > 2. **Manual entry** — Enter the URL directly | ||
|
|
||
| Based on their choice: | ||
| - If **Auto-discover**: Proceed to step 2a | ||
| - If **Manual entry**: Skip to step 2b | ||
|
|
||
| ### 2a. Auto-discover environments | ||
|
|
||
| **Check prerequisites:** | ||
| - Verify Azure CLI (`az`) is installed (check with `which az` or `where az` on Windows) | ||
| - If not installed, inform the user and fall back to step 2b | ||
|
|
||
| **Make the API call:** | ||
|
|
||
| 1. Check if the user is logged into Azure CLI: | ||
| ```bash | ||
| az account show | ||
| ``` | ||
| If this fails, prompt the user to log in: | ||
| ```bash | ||
| az login | ||
| ``` | ||
|
|
||
| 2. Get an access token for the Power Apps API: | ||
| ```bash | ||
| az account get-access-token --resource https://service.powerapps.com/ --query accessToken --output tsv | ||
| ``` | ||
|
|
||
| 3. Call the Power Apps API to list environments: | ||
| ``` | ||
| GET https://api.powerapps.com/providers/Microsoft.PowerApps/environments?api-version=2016-11-01 | ||
| Authorization: Bearer {token} | ||
| Accept: application/json | ||
| ``` | ||
|
|
||
| 4. Parse the JSON response and filter for environments where `properties?.linkedEnvironmentMetadata?.instanceUrl` is not null. | ||
|
|
||
| 5. For each matching environment, extract: | ||
| - `properties.displayName` as `displayName` | ||
| - `properties.linkedEnvironmentMetadata.instanceUrl` (remove trailing slash) as `instanceUrl` | ||
|
|
||
| 6. Create a list of environments in this format: | ||
| ```json | ||
| [ | ||
| { "displayName": "My Org (default)", "instanceUrl": "https://orgfbb52bb7.crm.dynamics.com" }, | ||
| { "displayName": "Another Env", "instanceUrl": "https://orgabc123.crm.dynamics.com" } | ||
| ] | ||
| ``` | ||
|
|
||
| **If the API call succeeds**, proceed to step 3. | ||
|
|
||
| **If the API call fails** (user not logged in, network error, no environments found, or any other error), tell the user what went wrong and fall back to step 2b. | ||
|
|
||
| ### 2b. Manual entry — ask for the URL | ||
|
|
||
| Ask the user to provide their environment URL directly: | ||
|
|
||
| > Please enter your Dataverse environment URL. | ||
| > | ||
| > Example: `https://myorg.crm10.dynamics.com` | ||
| > | ||
| > You can find this in the Power Platform Admin Center under Environments. | ||
|
|
||
| Then skip to step 4. | ||
|
|
||
| ### 3. Ask the user to select an environment | ||
|
|
||
| Present the environments as a numbered list. For each environment, check whether any URL in `CONFIGURED_URLS` starts with that environment's `instanceUrl` — if so, append **(already configured)** to the line. | ||
|
|
||
| > I found the following Dataverse environments on your account. Which one would you like to configure? | ||
| > | ||
| > 1. My Org (default) — `https://orgfbb52bb7.crm.dynamics.com` **(already configured)** | ||
| > 2. Another Env — `https://orgabc123.crm.dynamics.com` | ||
| > | ||
| > Enter the number of your choice, or type "manual" to enter a URL yourself. | ||
|
|
||
| If the user selects an already-configured environment, confirm that they want to re-register it (e.g. to change the endpoint type) before proceeding. | ||
|
|
||
| If the user types "manual", fall back to step 2b. | ||
|
|
||
| ### 4. Confirm the selected URL | ||
|
|
||
| Take the `instanceUrl` from the chosen environment (or the manually entered URL) and strip any trailing slash. This is `USER_URL` for the remainder of the skill. | ||
|
|
||
| ### 5. Confirm if the user wants "Preview" or "Generally Available (GA)" endpoint | ||
|
|
||
| Ask the user: | ||
|
|
||
| > Which endpoint would you like to use? | ||
| > 1. **Generally Available (GA)** — `/api/mcp` (recommended) | ||
| > 2. **Preview** — `/api/mcp_preview` (latest features, may be unstable) | ||
|
|
||
| Based on their choice: | ||
| - If **GA**: set `MCP_URL` to `{USER_URL}/api/mcp` | ||
| - If **Preview**: set `MCP_URL` to `{USER_URL}/api/mcp_preview` | ||
|
|
||
| ### 6. Register the MCP server | ||
|
|
||
| Update the MCP configuration file at `CONFIG_PATH` (determined in step 0) to add the new server. | ||
|
|
||
| **Generate a unique server name** from the `USER_URL`: | ||
| 1. Extract the subdomain (organization identifier) from the URL | ||
| - Example: `https://orgbc9a965c.crm10.dynamics.com` → `orgbc9a965c` | ||
| 2. Prepend `DataverseMcp` to create the server name | ||
| - Example: `DataverseMcporgbc9a965c` | ||
|
|
||
| This is the `SERVER_NAME`. | ||
|
|
||
| **Update the configuration file:** | ||
|
|
||
| 1. If `CONFIG_PATH` is for a **project-scoped** configuration (`.mcp/copilot/mcp.json`), ensure the directory exists first: | ||
| ```bash | ||
| mkdir -p .mcp/copilot | ||
| ``` | ||
|
|
||
| 2. Read the existing configuration file at `CONFIG_PATH`, or create a new empty config if it doesn't exist: | ||
| ```json | ||
| {} | ||
| ``` | ||
|
|
||
| 3. Determine which top-level key to use: | ||
| - If the config already has `"servers"`, use that | ||
| - Otherwise, use `"mcpServers"` | ||
|
|
||
| 4. Add or update the server entry: | ||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "{SERVER_NAME}": { | ||
| "type": "http", | ||
| "url": "{MCP_URL}" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| 5. Write the updated configuration back to `CONFIG_PATH` with proper JSON formatting (2-space indentation). | ||
|
|
||
| **Important notes:** | ||
| - Do NOT overwrite other entries in the configuration file | ||
| - Preserve the existing structure and formatting | ||
| - If `SERVER_NAME` already exists, update it with the new `MCP_URL` | ||
|
|
||
| Proceed to step 7. | ||
|
|
||
| ### 7. Confirm success and instruct restart | ||
|
|
||
| Tell the user: | ||
|
|
||
| > ✅ Dataverse MCP server configured for GitHub Copilot at `{MCP_URL}`. | ||
| > | ||
| > Configuration saved to: `{CONFIG_PATH}` | ||
| > | ||
| > **IMPORTANT: You must restart your editor for the changes to take effect.** | ||
| > | ||
| > Restart your editor or reload the window, then you will be able to: | ||
| > - List all tables in your Dataverse environment | ||
| > - Query records from any table | ||
| > - Create, update, or delete records | ||
| > - Explore your schema and relationships | ||
|
|
||
| ### 8. Troubleshooting | ||
|
|
||
| If something goes wrong, help the user check: | ||
|
|
||
| - The URL format is correct (`https://<org>.<region>.dynamics.com`) | ||
| - They have access to the Dataverse environment | ||
| - The environment URL matches what's shown in the Power Platform Admin Center | ||
| - Their Environment Admin has enabled "Dataverse CLI MCP" in the Allowed Clients list | ||
| - Their Environment has Dataverse MCP enabled, and if they're trying to use the preview endpoint that is enabled | ||
| - For project-scoped configuration, ensure the `.mcp/copilot/mcp.json` file was created successfully | ||
| - For global configuration, check permissions on the `~/.copilot/` directory |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.