|
1 |
| -# DevRev MCP server |
| 1 | +# DevRev MCP Server |
2 | 2 |
|
3 | 3 | ## Overview
|
4 | 4 |
|
5 |
| -A Model Context Protocol server for DevRev. It is used to search and retrieve information using the DevRev APIs. |
| 5 | +A Model Context Protocol server for DevRev. This server provides comprehensive access to DevRev's APIs, allowing you to manage work items (issues, tickets), parts (enhancements), search across your DevRev data, and retrieve user information. |
6 | 6 |
|
7 | 7 | ## Tools
|
8 | 8 |
|
9 |
| -- `search`: Search for information using the DevRev search API with the provided query and namespace. |
10 |
| -- `get_object`: Get all information about a DevRev issue or ticket using its ID. |
11 |
| -- `create_object`: Create a new issue or ticket in DevRev with specified properties. |
12 |
| -- `update_object`: Update an existing issue or ticket in DevRev by modifying its title or body content. |
| 9 | +### Search & Discovery |
| 10 | +- **`search`**: Search for information across DevRev using the search API with support for different namespaces (articles, issues, tickets, parts, dev_users, accounts, rev_orgs). |
| 11 | +- **`get_current_user`**: Fetch details about the currently authenticated DevRev user. |
| 12 | + |
| 13 | +### Work Items (Issues & Tickets) |
| 14 | +- **`get_work`**: Get comprehensive information about a specific DevRev work item using its ID. |
| 15 | +- **`create_work`**: Create new issues or tickets in DevRev with specified properties like title, body, assignees, and associated parts. |
| 16 | +- **`update_work`**: Update existing work items by modifying properties such as title, body, assignees, or associated parts. |
| 17 | +- **`list_works`**: List and filter work items based on various criteria like state, dates, assignees, parts, and more. |
| 18 | + |
| 19 | +### Parts (Enhancements) |
| 20 | +- **`get_part`**: Get detailed information about a specific part (enhancement) using its ID. |
| 21 | +- **`create_part`**: Create new parts (enhancements) with specified properties including name, description, assignees, and parent parts. |
| 22 | +- **`update_part`**: Update existing parts by modifying properties such as name, description, assignees, or target dates. |
| 23 | +- **`list_parts`**: List and filter parts based on various criteria like dates, assignees, parent parts, and more. |
13 | 24 |
|
14 | 25 | ## Configuration
|
15 | 26 |
|
16 |
| -### Get the DevRev API key |
| 27 | +### Get the DevRev API Key |
17 | 28 |
|
18 | 29 | 1. Go to https://app.devrev.ai/signup and create an account.
|
19 | 30 | 2. Import your data from your existing data sources like Salesforce, Zendesk while following the instructions [here](https://devrev.ai/docs/import#available-sources).
|
@@ -65,3 +76,12 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
|
65 | 76 | ```
|
66 | 77 |
|
67 | 78 | </details>
|
| 79 | + |
| 80 | +## Features |
| 81 | + |
| 82 | +- **Comprehensive Work Item Management**: Create, read, update, and list both issues and tickets |
| 83 | +- **Enhanced Part Management**: Full CRUD operations for parts (enhancements) including hierarchical relationships |
| 84 | +- **Advanced Search**: Search across multiple namespaces with hybrid search capabilities |
| 85 | +- **Flexible Filtering**: Advanced filtering options for listing work items and parts based on dates, assignees, states, and more |
| 86 | +- **User Context**: Access to current user information for personalized experiences |
| 87 | +- **Rich Data Support**: Handle complex relationships between work items, parts, users, and organizations |
0 commit comments