Skip to content

Commit 4dacbed

Browse files
NicoletaComanNicoletaComan
committed
Add MCP configs + troubleshooting
1 parent 86a722c commit 4dacbed

2 files changed

Lines changed: 104 additions & 5 deletions

File tree

content/en/docs/developerportal/maia-plan/maia-plan-mcp.md renamed to content/en/docs/developerportal/maia-plan/maia-plan-mcp/_index.md

Lines changed: 77 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Maia Plan as MCP Server"
33
url: /developerportal/maia-plan-mcp/
44
description: "Describes how to configure and use Maia Plan as an MCP server to retrieve project scope and solution content."
5-
weight: 10
5+
weight: 2
66
---
77

88
## Introduction
@@ -74,13 +74,85 @@ The steps to configure your MCP client depend on the client you are using. The f
7474

7575
To configure Claude Code to connect to the Maia Plan MCP Server, follow these steps:
7676

77-
1. Open your Claude Code configuration file.
78-
2. Add the Maia Plan MCP Server to the list of available MCP servers.
79-
3. Specify the server URL and authentication method (using the `MENDIX_TOKEN` environment variable).
80-
4. Save the configuration file.
77+
1. Open your Claude Code configuration file. This is available at the following paths:
78+
79+
* Windows: `C:/Users/<YourUsername>/.claude/settings.json`
80+
* macOS/Linux: `~/.claude/settings.json`
81+
82+
2. Add the Maia Plan MCP Server to the list of available MCP servers and specify the server URL and authentication method (using the `MENDIX_TOKEN` environment variable). To do that, add the following server configuration:
83+
84+
```json
85+
{
86+
"servers": {
87+
"mendixMcp": {
88+
"type": "http",
89+
"url": "https://plan.home.mendix.com/mcp-server/mcp",
90+
"headers": {
91+
"Authorization": "Bearer $MENDIX_TOKEN"
92+
}
93+
}
94+
}
95+
}
96+
```
97+
98+
3. Save the configuration file.
99+
4. Verify the setup by following these steps:
100+
101+
1. Run the `claude mcp list` command.
102+
2. In the Claude Code chat, enter `Show my recent plans`.
103+
3. In the Claude Code chat, enter `Show details for plan UUID <your-plan-uuid>`.
81104

82105
For detailed instructions, refer to the [Claude Code documentation](https://claude.com/docs/connectors/building/mcp).
83106

107+
#### Configuring Visual Studio Code Copilot
108+
109+
To configure Visual Studio Code Copilot to connect to the Maia Plan MCP server, follow these steps:
110+
111+
1. Open the Visual Studio Code MCP configuration file:
112+
113+
* User-level: `C:/Users/<YourUsername>/AppData/Roaming/Code/User/mcp.json`
114+
* Workspace-level (optional): `.vscode/mcp.json`
115+
116+
2. Add the Maia Plan MCP Server to the list of available MCP servers and specify the server URL and authentication method (using the `MENDIX_TOKEN` environment variable). To do that, add the following server configuration:
117+
118+
```json
119+
{
120+
"servers": {
121+
"mendixMcp": {
122+
"type": "http",
123+
"url": "https://plan.home.mendix.com/mcp-server/mcp",
124+
"headers": {
125+
"Authorization": "Bearer ${env:MENDIX_TOKEN}"
126+
}
127+
}
128+
}
129+
}
130+
```
131+
3. In Visual Studio Code, follow these steps:
132+
133+
1. Open **Command Palette**.
134+
2. Run **MCP: List Servers**.
135+
3. Select **mendixMCP**.
136+
4. Start or restart the server.
137+
5. Accept the trust prompt if needed.
138+
139+
4. Verify the setup by entering the following in the Visual Studio Code Copilot chat:
140+
141+
1. `Show my recent plans`
142+
2. `Show details for plan UUID <your-plan-uuid>`
143+
144+
##### Automatically Starting the Copilot MCP
145+
146+
You can optionally choose to automatically start configured MCP servers for Visual Studio Code Copilot chat. To do that, add the following setting to the settings file (found at `C:/Users/<YourUsername>/AppData/Roaming/Code/User/settings.json`):
147+
148+
```json
149+
"chat.mcp.autostart": true
150+
```
151+
152+
If the server is not automatically started, reload or restart Visual Studio Code.
153+
154+
If you do not set the automatic start option, you can still start servers using **MCP: List Servers**.
155+
84156
#### Configuring Other MCP Clients
85157

86158
For other MCP clients, refer to the client documentation for instructions on adding external MCP servers and configuring authentication. Most MCP clients support environment variable-based authentication, which is the recommended approach.

‎content/en/docs/developerportal/maia-plan/maia-plan-mcp/troubleshooting.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: "Troubleshooting Maia Plan as MCP Server"
3+
linktitle: "Troubleshooting"
4+
url: /developerportal/maia-plan-mcp-troubleshooting/
5+
description: "Describes how to fix potential Maia Plan as an MCP server issues."
6+
weight: 10
7+
---
8+
9+
## Introduction
10+
11+
If you encounter issues with Maia Plan as MCP Server, use the following troubleshooting tips to solve them.
12+
13+
## 401 or 403 Errors
14+
15+
Your PAT is invalid or expired. Regenerate the token in [User Settings](/portal/user-settings/#pat) and update the `MENDIX_TOKEN` environment variable.
16+
17+
## Tools Do Not Appear in Copilot
18+
19+
Confirm that `mcp.json` is in the correct location (see [Configuring Visual Studio Code Copilot](#configuring-visual-studio-code-copilot)), then open **Command Palette** and run **MCP: Reset Cached Tools**.
20+
21+
## Server Does Not Start
22+
23+
Open **Command Palette**, run **MCP: Reset Trust**, then trust the server again when prompted.
24+
25+
## Environment Variable Not Detected
26+
27+
Fully restart Visual Studio Code after setting the `MENDIX_TOKEN` environment variable. A reload is not sufficient.

0 commit comments

Comments
 (0)