@lotfihoc/ado-on-prem-mcp 1.0.1 โ 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -136
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,101 +4,6 @@ This project provides a lightweight server to interact with on-premises Azure De
|
|
|
4
4
|
|
|
5
5
|
Forked from [web-marketing-hr](https://www.npmjs.com/package/@web-marketing-hr/azure-devops-mcp), which itself is a fork of [Microsoft's Azure DevOps MCP](https://github.com/microsoft/azure-devops-mcp)
|
|
6
6
|
|
|
7
|
-
### Environment variables
|
|
8
|
-
|
|
9
|
-
- `ADO_MCP_AUTH_TOKEN`:
|
|
10
|
-
- DevOps Personal Access Token (PAT)
|
|
11
|
-
- `ADO_MCP_MODE`:
|
|
12
|
-
- Whether Azure DevOps is on-premises or in the cloud
|
|
13
|
-
- `"cloud"` (default) or `"onprem"`
|
|
14
|
-
- `ADO_MCP_AUTH_TYPE`
|
|
15
|
-
- DevOps authentication mode
|
|
16
|
-
- `"bearer"` (default) or `"basic"`
|
|
17
|
-
- `ADO_MCP_ORG_URL`:
|
|
18
|
-
- Full URL of the on-premises instance, for example:
|
|
19
|
-
`https://my-server/tfs/MyCollection`
|
|
20
|
-
- `ADO_MCP_API_VERSION`:
|
|
21
|
-
- Set Azure DevOps API version
|
|
22
|
-
- default: `"6.0-preview"`
|
|
23
|
-
- `ADO_MCP_BATCH_API_VERSION`:
|
|
24
|
-
- Set Azure DevOps Batch API version
|
|
25
|
-
- default: `"6.0-preview"`
|
|
26
|
-
- `ADO_MCP_MARKDOWN_COMMENTS_API_VERSION`:
|
|
27
|
-
- Set Azure DevOps Markdown API version
|
|
28
|
-
- default: `"5.0"`
|
|
29
|
-
|
|
30
|
-
### Set environment variables in mcp.json
|
|
31
|
-
|
|
32
|
-
You can set environment variables in `mcp.json`, for example:
|
|
33
|
-
|
|
34
|
-
```json
|
|
35
|
-
{
|
|
36
|
-
"servers": {
|
|
37
|
-
"ado-on-prem-mcp": {
|
|
38
|
-
"type": "stdio",
|
|
39
|
-
"command": "npx",
|
|
40
|
-
"args": ["-y", "@lotfihoc/ado-on-prem-mcp", "<your_devops_project_name>", "--authentication", "envvar"],
|
|
41
|
-
"env": {
|
|
42
|
-
"LOG_LEVEL": "info",
|
|
43
|
-
"ADO_MCP_MODE": "onprem",
|
|
44
|
-
"ADO_MCP_AUTH_TYPE": "basic",
|
|
45
|
-
"ADO_MCP_ORG_URL": "https://<on-prem-host>/tfs/<collection_name>",
|
|
46
|
-
"ADO_MCP_API_VERSION": "6.0",
|
|
47
|
-
"ADO_MCP_BATCH_API_VERSION": "6.0",
|
|
48
|
-
"ADO_MCP_MARKDOWN_COMMENTS_API_VERSION": "5.0",
|
|
49
|
-
"NODE_EXTRA_CA_CERTS": "your_cert_path", // make this availble system wide if needed
|
|
50
|
-
"ADO_MCP_AUTH_TOKEN": "your_ado_pat" // make this availble system wide
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
If you are using continue dev on vscode, you can use this config
|
|
58
|
-
|
|
59
|
-
```yaml
|
|
60
|
-
mcpServers:
|
|
61
|
-
- name: ado-on-prem-mcp
|
|
62
|
-
type: stdio
|
|
63
|
-
command: npx
|
|
64
|
-
args:
|
|
65
|
-
- -y
|
|
66
|
-
- "@lotfihoc/ado-on-prem-mcp"
|
|
67
|
-
- "<your_devops_project_name>"
|
|
68
|
-
- "--authentication"
|
|
69
|
-
- "envvar"
|
|
70
|
-
env:
|
|
71
|
-
LOG_LEVEL: "info"
|
|
72
|
-
ADO_MCP_MODE: "onprem"
|
|
73
|
-
ADO_MCP_AUTH_TYPE: "basic"
|
|
74
|
-
ADO_MCP_ORG_URL: "https://<on-prem-host>/tfs/<collection_name>"
|
|
75
|
-
ADO_MCP_API_VERSION: "6.0"
|
|
76
|
-
ADO_MCP_BATCH_API_VERSION: "6.0"
|
|
77
|
-
ADO_MCP_MARKDOWN_COMMENTS_API_VERSION: "5.0"
|
|
78
|
-
ADO_MCP_AUTH_TOKEN: ${{ secrets.ADO_TOKEN }}
|
|
79
|
-
NODE_EXTRA_CA_CERTS: ${{ secrets.NODE_EXTRA_CA_CERTS }}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
It's recommended to set `ADO_MCP_AUTH_TOKEN` in your terminal or command line. Windows example:
|
|
83
|
-
|
|
84
|
-
```bat
|
|
85
|
-
setx ADO_MCP_AUTH_TOKEN "<pat_token>"`
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
## Upstream README
|
|
89
|
-
|
|
90
|
-
## ๐ Table of Contents
|
|
91
|
-
|
|
92
|
-
1. [๐บ Overview](#-overview)
|
|
93
|
-
2. [๐ Expectations](#-expectations)
|
|
94
|
-
3. [โ๏ธ Supported Tools](#๏ธ-supported-tools)
|
|
95
|
-
4. [๐ Installation & Getting Started](#-installation--getting-started)
|
|
96
|
-
5. [๐ Using Domains](#-using-domains)
|
|
97
|
-
6. [๐ Troubleshooting](#-troubleshooting)
|
|
98
|
-
7. [๐ฉ Examples & Best Practices](#-examples--best-practices)
|
|
99
|
-
8. [๐โโ๏ธ Frequently Asked Questions](#๏ธ-frequently-asked-questions)
|
|
100
|
-
9. [๐ Contributing](#-contributing)
|
|
101
|
-
|
|
102
7
|
## ๐บ Overview
|
|
103
8
|
|
|
104
9
|
The Azure DevOps MCP Server brings Azure DevOps context to your agents. Try prompts like:
|
|
@@ -136,37 +41,15 @@ For the best experience, use Visual Studio Code and GitHub Copilot. See the [get
|
|
|
136
41
|
|
|
137
42
|
### Installation
|
|
138
43
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
[](https://insiders.vscode.dev/redirect/mcp/install?name=ado&config=%7B%20%22type%22%3A%20%22stdio%22%2C%20%22command%22%3A%20%22npx%22%2C%20%22args%22%3A%20%5B%22-y%22%2C%20%22%40azure-devops%2Fmcp%22%2C%20%22%24%7Binput%3Aado_org%7D%22%5D%7D&inputs=%5B%7B%22id%22%3A%20%22ado_org%22%2C%20%22type%22%3A%20%22promptString%22%2C%20%22description%22%3A%20%22Azure%20DevOps%20organization%20name%20%20%28e.g.%20%27contoso%27%29%22%7D%5D)
|
|
142
|
-
[](https://insiders.vscode.dev/redirect/mcp/install?name=ado&quality=insiders&config=%7B%20%22type%22%3A%20%22stdio%22%2C%20%22command%22%3A%20%22npx%22%2C%20%22args%22%3A%20%5B%22-y%22%2C%20%22%40azure-devops%2Fmcp%22%2C%20%22%24%7Binput%3Aado_org%7D%22%5D%7D&inputs=%5B%7B%22id%22%3A%20%22ado_org%22%2C%20%22type%22%3A%20%22promptString%22%2C%20%22description%22%3A%20%22Azure%20DevOps%20organization%20name%20%20%28e.g.%20%27contoso%27%29%22%7D%5D)
|
|
143
|
-
|
|
144
|
-
After installation, select GitHub Copilot Agent Mode and refresh the tools list. Learn more about Agent Mode in the [VS Code Documentation](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode).
|
|
145
|
-
|
|
146
|
-
#### ๐งจ Install from Public Feed (Recommended)
|
|
147
|
-
|
|
148
|
-
This installation method is the easiest for all users of Visual Studio Code.
|
|
149
|
-
|
|
150
|
-
๐ฅ [Watch this quick start video to get up and running in under two minutes!](https://youtu.be/EUmFM6qXoYk)
|
|
151
|
-
|
|
152
|
-
##### Steps
|
|
153
|
-
|
|
154
|
-
In your project, add a `.vscode\mcp.json` file with the following content:
|
|
44
|
+
In your project, add a `.vscode\mcp.json` file and setup environment varibales with the following content:
|
|
155
45
|
|
|
156
46
|
```json
|
|
157
47
|
{
|
|
158
|
-
"inputs": [
|
|
159
|
-
{
|
|
160
|
-
"id": "ado_org",
|
|
161
|
-
"type": "promptString",
|
|
162
|
-
"description": "Azure DevOps organization name"
|
|
163
|
-
}
|
|
164
|
-
],
|
|
165
48
|
"servers": {
|
|
166
49
|
"ado-on-prem-mcp": {
|
|
167
50
|
"type": "stdio",
|
|
168
51
|
"command": "npx",
|
|
169
|
-
"args": ["-y", "@lotfihoc/ado-on-prem-mcp", "
|
|
52
|
+
"args": ["-y", "@lotfihoc/ado-on-prem-mcp", "<your_devops_project_name>", "--authentication", "envvar"],
|
|
170
53
|
"env": {
|
|
171
54
|
"LOG_LEVEL": "info",
|
|
172
55
|
"ADO_MCP_MODE": "onprem",
|
|
@@ -183,22 +66,73 @@ In your project, add a `.vscode\mcp.json` file with the following content:
|
|
|
183
66
|
}
|
|
184
67
|
```
|
|
185
68
|
|
|
69
|
+
#### Environment variables
|
|
70
|
+
|
|
71
|
+
- `ADO_MCP_AUTH_TOKEN`:
|
|
72
|
+
- DevOps Personal Access Token (PAT)
|
|
73
|
+
- `ADO_MCP_MODE`:
|
|
74
|
+
- Whether Azure DevOps is on-premises or in the cloud
|
|
75
|
+
- `"cloud"` (default) or `"onprem"`
|
|
76
|
+
- `ADO_MCP_AUTH_TYPE`
|
|
77
|
+
- DevOps authentication mode
|
|
78
|
+
- `"bearer"` (default) or `"basic"`
|
|
79
|
+
- `ADO_MCP_ORG_URL`:
|
|
80
|
+
- Full URL of the on-premises instance, for example:
|
|
81
|
+
`https://my-server/tfs/MyCollection`
|
|
82
|
+
- `ADO_MCP_API_VERSION`:
|
|
83
|
+
- Set Azure DevOps API version
|
|
84
|
+
- default: `"6.0-preview"`
|
|
85
|
+
- `ADO_MCP_BATCH_API_VERSION`:
|
|
86
|
+
- Set Azure DevOps Batch API version
|
|
87
|
+
- default: `"6.0-preview"`
|
|
88
|
+
- `ADO_MCP_MARKDOWN_COMMENTS_API_VERSION`:
|
|
89
|
+
- Set Azure DevOps Markdown API version
|
|
90
|
+
- default: `"5.0"`
|
|
91
|
+
- `NODE_EXTRA_CA_CERTS`:
|
|
92
|
+
- Set this variable to your certifcat path if needed
|
|
93
|
+
- `ADO_MCP_AUTH_TOKEN`:
|
|
94
|
+
- Ado PAT
|
|
95
|
+
|
|
96
|
+
If you are using continue dev on vscode, you can use this config
|
|
97
|
+
|
|
98
|
+
```yaml
|
|
99
|
+
mcpServers:
|
|
100
|
+
- name: ado-on-prem-mcp
|
|
101
|
+
type: stdio
|
|
102
|
+
command: npx
|
|
103
|
+
args:
|
|
104
|
+
- -y
|
|
105
|
+
- "@lotfihoc/ado-on-prem-mcp"
|
|
106
|
+
- "<your_devops_project_name>"
|
|
107
|
+
- "--authentication"
|
|
108
|
+
- "envvar"
|
|
109
|
+
env:
|
|
110
|
+
LOG_LEVEL: "info"
|
|
111
|
+
ADO_MCP_MODE: "onprem"
|
|
112
|
+
ADO_MCP_AUTH_TYPE: "basic"
|
|
113
|
+
ADO_MCP_ORG_URL: "https://<on-prem-host>/tfs/<collection_name>"
|
|
114
|
+
ADO_MCP_API_VERSION: "6.0"
|
|
115
|
+
ADO_MCP_BATCH_API_VERSION: "6.0"
|
|
116
|
+
ADO_MCP_MARKDOWN_COMMENTS_API_VERSION: "5.0"
|
|
117
|
+
ADO_MCP_AUTH_TOKEN: ${{ secrets.ADO_TOKEN }}
|
|
118
|
+
NODE_EXTRA_CA_CERTS: ${{ secrets.NODE_EXTRA_CA_CERTS }}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
It's recommended to set `ADO_MCP_AUTH_TOKEN` in your terminal or command line. Windows example:
|
|
122
|
+
|
|
123
|
+
```bat
|
|
124
|
+
setx ADO_MCP_AUTH_TOKEN "<pat_token>"`
|
|
125
|
+
```
|
|
126
|
+
|
|
186
127
|
๐ฅ To stay up to date with the latest features, you can use our nightly builds. Simply update your `mcp.json` configuration to use `@lotfihoc/ado-on-prem-mcp@next`. Here is an updated example:
|
|
187
128
|
|
|
188
129
|
```json
|
|
189
130
|
{
|
|
190
|
-
"inputs": [
|
|
191
|
-
{
|
|
192
|
-
"id": "ado_org",
|
|
193
|
-
"type": "promptString",
|
|
194
|
-
"description": "Azure DevOps organization name"
|
|
195
|
-
}
|
|
196
|
-
],
|
|
197
131
|
"servers": {
|
|
198
132
|
"ado-on-prem-mcp": {
|
|
199
133
|
"type": "stdio",
|
|
200
134
|
"command": "npx",
|
|
201
|
-
"args": ["-y", "@lotfihoc/ado-on-prem-mcp
|
|
135
|
+
"args": ["-y", "@lotfihoc/ado-on-prem-mcp", "<your_devops_project_name>", "--authentication", "envvar"],
|
|
202
136
|
"env": {
|
|
203
137
|
"LOG_LEVEL": "info",
|
|
204
138
|
"ADO_MCP_MODE": "onprem",
|
|
@@ -242,18 +176,11 @@ For example, use `"-d", "core", "work", "work-items"` to load only Work Item rel
|
|
|
242
176
|
|
|
243
177
|
```json
|
|
244
178
|
{
|
|
245
|
-
"inputs": [
|
|
246
|
-
{
|
|
247
|
-
"id": "ado_org",
|
|
248
|
-
"type": "promptString",
|
|
249
|
-
"description": "Azure DevOps organization name"
|
|
250
|
-
}
|
|
251
|
-
],
|
|
252
179
|
"servers": {
|
|
253
180
|
"ado-on-prem-mcp-with-filtered-domains": {
|
|
254
181
|
"type": "stdio",
|
|
255
182
|
"command": "npx",
|
|
256
|
-
"args": ["-y", "@lotfihoc/ado-on-prem-mcp", "
|
|
183
|
+
"args": ["-y", "@lotfihoc/ado-on-prem-mcp", "<your_devops_project_name>", "-d", "core", "work", "work-items", "--authentication", "envvar"],
|
|
257
184
|
"env": {
|
|
258
185
|
"LOG_LEVEL": "info",
|
|
259
186
|
"ADO_MCP_MODE": "onprem",
|
|
@@ -268,7 +195,6 @@ For example, use `"-d", "core", "work", "work-items"` to load only Work Item rel
|
|
|
268
195
|
}
|
|
269
196
|
}
|
|
270
197
|
}
|
|
271
|
-
|
|
272
198
|
```
|
|
273
199
|
|
|
274
200
|
Domains that are available are: `core`, `work`, `work-items`, `search`, `test-plans`, `repositories`, `wiki`, `pipelines`, `advanced-security`
|
package/dist/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const packageVersion = "1.0.
|
|
1
|
+
export const packageVersion = "1.0.03";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lotfihoc/ado-on-prem-mcp",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.03",
|
|
4
4
|
"description": "MCP server for interacting with Azure DevOps (on-premises) WEM fork",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Microsoft Corporation, WEB Marketing d.o.o. Fork, Lotfi Hoc",
|