Skip to content

Commit 79ad732

Browse files
How to guide on setup in Cursor (#329)
Added instructions and link to video on using Cursor ## GitHub issue number #298 ## **Associated Risks** None ## ✅ **PR Checklist** - [x] **I have read the [contribution guidelines](https://github.com/microsoft/azure-devops-mcp/blob/main/CONTRIBUTING.md)** - [x] **I have read the [code of conduct guidelines](https://github.com/microsoft/azure-devops-mcp/blob/main/CODE_OF_CONDUCT.md)** - [x] Title of the pull request is clear and informative. - [x] 👌 Code hygiene - [x] 🔭 Telemetry added, updated, or N/A - [x] 📄 Documentation added, updated, or N/A - [x] 🛡️ Automated tests added, or N/A ## 🧪 **How did you test it?** None --------- Co-authored-by: Engin Polat <[email protected]>
1 parent a9bf4d1 commit 79ad732

File tree

2 files changed

+47
-5
lines changed

2 files changed

+47
-5
lines changed

docs/HOWTO.md

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Before you get started, ensure you follow the steps in the `README.md` file. This will help you get up and running and connected to your Azure DevOps organization.
22

3-
## ✏️ Modify Copilot Instructions
3+
[🥇 How to make your experience better](#-how-to-make-your-experience-better)<br/>
4+
[🚗 Using MCP Server with Visual Studio Code](#-using-mcp-server-with-visual-studio-code)<br/>
5+
[🤖 Using MCP Server with Claude Code](#-using-mcp-server-with-claude-code)<br/>
6+
[🍇 Using MCP Server with Cursor](#-using-mcp-server-with-cursor)<br/>
7+
8+
# 🥇 How to make your experience better
9+
10+
### Modify Copilot Instructions
411

512
The `.github/copilot-instructions.md` file is a great way to customize the GitHub Copilot experience, especially when working with MCP Server for Azure DevOps.
613

@@ -18,13 +25,13 @@ Here is an example modification you can add to your existing `.github/copilot-in
1825
When getting work items using MCP Server for Azure DevOps, always try to use batch tools for updates instead of many individual single updates. For updates, try and update up to 200 updates in a single batch. When getting work items, once you get the list of IDs, use the tool `get_work_items_batch_by_ids` to get the work item details. By default, show fields ID, Type, Title, State. Show work item results in a rendered markdown table.
1926
```
2027

21-
## 🎯 Different Models
28+
### Use different models
2229

2330
Communicating with the LLM is both an art and a science. If the model does not respond well, switching to a different model may improve your results.
2431

25-
## 🚗 Using MCP Server in Visual Studio Code
32+
# 🚗 Using MCP Server with Visual Studio Code
2633

27-
### Start the Azure DevOps MCP Server:
34+
### Start the Azure DevOps MCP Server
2835

2936
To start the Azure DevOps MCP Server, open the `.vscode\mcp.json` file and click 'Start'
3037

@@ -160,7 +167,7 @@ Update work item 12345 with a new description and use Markdown text. Use Markdow
160167

161168
📽️ [Azure DevOps MCP Server: Using Markdown format for create and update work items](https://youtu.be/OD4c2m7Fj9U)
162169

163-
## 🤖 Setup MCP Server with Claude Code
170+
# 🤖 Using MCP Server with Claude Code
164171

165172
See https://docs.anthropic.com/en/docs/claude-code/mcp for general guidance on adding MCP Server to Claude Code experience.
166173

@@ -171,3 +178,38 @@ claude mcp add azure-devops -- npx -y @azure-devops/mcp Contoso
171178
```
172179

173180
Replace `Contoso` with your own organization name
181+
182+
# 🍇 Using MCP Server with Cursor
183+
184+
To integrate the Azure DevOps MCP Server with Cursor, create a `.cursor\mcp.json` file and add your Azure DevOps organization to the `mcpServers` list.
185+
186+
```json
187+
{
188+
"mcpServers": {
189+
"ado": {
190+
"command": "npx",
191+
"args": ["-y", "@azure-devops/mcp", "{Contoso}"]
192+
}
193+
}
194+
}
195+
```
196+
197+
Replace `{Contoso}` with your actual Azure DevOps organization name.
198+
199+
Save the file, and when Cursor detects the MCP Server, click **Enable**.
200+
201+
<img src="./media/enable-mcp-server-from-cursor.png" alt="enable mcp server from cursor" width="500"/>
202+
203+
### Start the Azure DevOps MCP Server
204+
205+
Open the terminal and start the MCP Server with:
206+
207+
```
208+
npx -y @azure-devops/mcp {Contoso}
209+
```
210+
211+
Replace `Contoso` with your Azure DevOps organization.
212+
213+
You can now use the Azure DevOps MCP Server tools directly in chat.
214+
215+
📽️ [Azure DevOps MCP Server: Getting started with Cursor](https://youtu.be/550VPTnjYRg)
19.3 KB
Loading

0 commit comments

Comments
 (0)