Skip to content

Commit 84fea39

Browse files
author
Kyle Rader
committed
update docs
1 parent dba9506 commit 84fea39

File tree

2 files changed

+68
-0
lines changed

2 files changed

+68
-0
lines changed

docs/GETTINGSTARTED.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,38 @@ Click "Select Tools" and choose the available tools.
8888
3. The server appears in the tools list.
8989
4. Try prompts like "List ADO projects".
9090

91+
##### Using Token Authentication via Environment Variables
92+
93+
For automated scenarios or when you want to use a token stored in an environment variable, you can use the `ENV_` authentication pattern:
94+
95+
1. **Set your token in an environment variable:**
96+
97+
```bash
98+
export ADO_TOKEN="your-azure-devops-token"
99+
```
100+
101+
2. **Update your `.vscode/mcp.json` to use token authentication:**
102+
```json
103+
{
104+
"inputs": [
105+
{
106+
"id": "ado_org",
107+
"type": "promptString",
108+
"description": "Azure DevOps organization name (e.g. 'contoso')"
109+
}
110+
],
111+
"servers": {
112+
"ado": {
113+
"type": "stdio",
114+
"command": "npx",
115+
"args": ["-y", "@azure-devops/mcp", "${input:ado_org}", "--authentication", "ENV_ADO_TOKEN"]
116+
}
117+
}
118+
}
119+
```
120+
121+
This approach is particularly useful for CI/pipeline scenarios or when you want to avoid interactive authentication and use another credential source.
122+
91123
#### 🛠️ Install from Source (Dev Mode)
92124

93125
This installation method is recommended for advanced users and contributors who want immediate access to the latest updates from the main branch. It is ideal if you are developing new tools, enhancing existing features, or maintaining a custom fork.

docs/TROUBLESHOOTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,42 @@
4848

4949
## Authentication Issues
5050

51+
### Token Authentication via Environment Variables
52+
53+
For automated scenarios or when you want to use a token stored in an environment variable, you can use the `ENV_` authentication pattern:
54+
55+
1. **Set your token in an environment variable:**
56+
57+
```bash
58+
export ADO_TOKEN="your-azure-devops-token"
59+
```
60+
61+
2. **Use the ENV\_ authentication pattern:**
62+
63+
```bash
64+
npx @azure-devops/mcp myorg --authentication ENV_ADO_TOKEN
65+
```
66+
67+
3. **For MCP configuration files, update your `.vscode/mcp.json`:**
68+
```json
69+
{
70+
"inputs": [
71+
{
72+
"id": "ado_org",
73+
"type": "promptString",
74+
"description": "Azure DevOps organization name (e.g. 'contoso')"
75+
}
76+
],
77+
"servers": {
78+
"ado": {
79+
"type": "stdio",
80+
"command": "npx",
81+
"args": ["-y", "@azure-devops/mcp", "${input:ado_org}", "--authentication", "ENV_ADO_TOKEN"]
82+
}
83+
}
84+
}
85+
```
86+
5187
### GitHub Codespaces
5288

5389
Due to limitations of the environment default OAuth option is not available in Codespace.

0 commit comments

Comments
 (0)