docs: Add DevRev MCP Guide for AI Assistant Integration #290
Conversation
- Introduced a comprehensive guide on integrating DevRev with AI assistants using the Model Context Protocol (MCP). - Included sections on prerequisites, installation, configuration, tool categories, practical use cases, best practices, troubleshooting, and advanced workflows. - Enhanced documentation structure for improved clarity and user navigation.
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email [email protected]. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
🚫 [EkLine] <EK00037>
'********** - Query Work Items' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🔧 Parts Management Tools' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'******** - Retrieve Part Details' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'*********** - Create New Parts' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'*********** - Modify Existing Parts' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'********** - Query Parts' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'👥 Meetings & Communication Tools' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'************* - Query Meetings' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'⚡ Workflow Management Tools' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'********************** - Check Valid Transitions' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'****************** - Add Progress Updates' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'*********** - Sprint Information' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'************* - Available Subtypes' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Practical Use Cases & Examples' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'👔 Project Manager Workflows' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Sprint Planning & Management' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Progress Tracking' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'👨💻 Developer Workflows' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Bug Investigation & Resolution' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Feature Development' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🎧 Support Team Workflows' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Customer Issue Management' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Escalation Management' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🎯 Cross-Team Collaboration' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Release Planning' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Incident Response' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Best Practices' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🎯 Efficient Tool Usage' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Use Specific Searches' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Batch Operations' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🔄 Workflow Optimization' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Standard Workflows' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'API Key Management' should use sentence-style capitalization. (EK00037)
📝 [EkLine] <EK00006>
Remove 'regularly' if it's not important to the meaning of the statement. (EK00006)
🚫 [EkLine] <EK00037>
'Rate Limiting Considerations' should use sentence-style capitalization. (EK00037)
📝 [EkLine] <EK00006>
Remove 'naturally ' if it's not important to the meaning of the statement. (EK00006)
🚫 [EkLine] <EK00037>
'Error Handling' should use sentence-style capitalization. (EK00037)
📝 [EkLine] <EK00006>
Remove 'gracefully' if it's not important to the meaning of the statement. (EK00006)
🚫 [EkLine] <EK00037>
'Common Issues & Solutions' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🚫 MCP Server Not Starting' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🔑 Authentication Errors' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🔧 Tool-Specific Issues' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Getting Help' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Log Analysis' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'DevRev Support Channels' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Advanced Workflows' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🔄 Multi-Step Automation' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Automated Triage Workflow' should use sentence-style capitalization. (EK00037)
📝 [EkLine] <EK00006>
Remove 'properly' if it's not important to the meaning of the statement. (EK00006)
🚫 [EkLine] <EK00037>
'Release Coordination' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'🔍 Advanced Search Strategies' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Cross-Entity Analysis' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Trend Analysis' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Workflow Templates' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'General Questions' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Technical Questions' should use sentence-style capitalization. (EK00037)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
🚫 [EkLine] <EK00037>
'Workflow Questions' should use sentence-style capitalization. (EK00037)
Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
🚫 [EkLine] <EK00012>
Don't use exclamation points in text. (EK00012)
🚫 [EkLine] <EK00037>
'Next Steps' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00037>
'Additional Resources' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] <EK00012>
Don't use exclamation points in text. (EK00012)
🚫 [EkLine] <EK20001>
Confirm the link. The URL 'https://community.devrev.ai' seems inaccessible. It might be incorrect or improperly formatted. (EK20001)
|
|
||
| Model Context Protocol (MCP) is a revolutionary standard that enables AI assistants to securely connect with external data sources and tools. Think of it as a bridge that allows your AI assistant to interact with your business systems in real-time, providing contextual and up-to-date information. | ||
|
|
||
| ### Key Benefits of MCP |
|
|
||
| --- | ||
|
|
||
| ## Prerequisites & Setup |
|
|
||
| ## Prerequisites & Setup | ||
|
|
||
| ### System Requirements |
|
|
||
| The DevRev MCP server requires `uv` - a fast Python package installer and project manager. | ||
|
|
||
| #### Installation Methods |
| "Show my user details and permissions" | ||
| ``` | ||
|
|
||
| #### `get_vista` - Sprint Board Information |
| "Get information about the mobile team's sprint board" | ||
| ``` | ||
|
|
||
| ### 📋 Work Items Management Tools |
|
|
||
| ### 📋 Work Items Management Tools | ||
|
|
||
| #### `get_work` - Retrieve Work Item Details |
| "Get information about work item TICKET-456" | ||
| ``` | ||
|
|
||
| #### `create_work` - Create New Work Items |
| "Create an issue for implementing user authentication feature" | ||
| ``` | ||
|
|
||
| #### `update_work` - Modify Existing Work Items |
|
Published docs preview URL: https://devrev-preview-c18c9cae-aa80-434f-9262-f93b1ff4786c.docs.buildwithfern.com |
| title: "DevRev MCP Guide: Supercharge Your AI Assistant with DevRev Integration" | ||
| description: "Transform your AI workflow with seamless DevRev integration through Model Context Protocol" |
There was a problem hiding this comment.
In general "DevRev" is way overused in this doc.
| 1. [Introduction to Model Context Protocol](#introduction-to-model-context-protocol) | ||
| 2. [Prerequisites & Setup](#prerequisites--setup) | ||
| 3. [DevRev MCP Installation & Configuration](#devrev-mcp-installation--configuration) | ||
| 4. [Tool Categories Overview](#tool-categories-overview) | ||
| 5. [Detailed Tool Documentation](#detailed-tool-documentation) | ||
| 6. [Practical Use Cases & Examples](#practical-use-cases--examples) | ||
| 7. [Best Practices](#best-practices) | ||
| 8. [Troubleshooting](#troubleshooting) | ||
| 9. [Advanced Workflows](#advanced-workflows) | ||
| 10. [FAQ](#faq) |
There was a problem hiding this comment.
Fern automatically generates a TOC based on the headings so this one is redundant.
| 1. [Introduction to Model Context Protocol](#introduction-to-model-context-protocol) | |
| 2. [Prerequisites & Setup](#prerequisites--setup) | |
| 3. [DevRev MCP Installation & Configuration](#devrev-mcp-installation--configuration) | |
| 4. [Tool Categories Overview](#tool-categories-overview) | |
| 5. [Detailed Tool Documentation](#detailed-tool-documentation) | |
| 6. [Practical Use Cases & Examples](#practical-use-cases--examples) | |
| 7. [Best Practices](#best-practices) | |
| 8. [Troubleshooting](#troubleshooting) | |
| 9. [Advanced Workflows](#advanced-workflows) | |
| 10. [FAQ](#faq) |
|
|
||
| The DevRev MCP server requires `uv` - a fast Python package installer and project manager. | ||
|
|
||
| #### Installation Methods |
There was a problem hiding this comment.
H4 is too deep. Restructure so you don't need anything deeper than H3.
Here, you don't need separate sections for installation and verification, just have two commands in one codeblock. And you can use tabs for the different platforms. https://buildwithfern.com/learn/docs/writing-content/components/code-blocks#code-blocks-with-tabs
|
|
||
| #### Installation Methods | ||
|
|
||
| **macOS and Linux (Recommended):** |
There was a problem hiding this comment.
Why are these recommended?
| curl -LsSf https://astral.sh/uv/install.sh | sh | ||
| ``` | ||
|
|
||
| **Windows:** |
There was a problem hiding this comment.
Use codeblock titles. https://buildwithfern.com/learn/docs/writing-content/components/code-blocks#titles
| **Q: Do I need a paid DevRev account to use the MCP server?** | ||
| A: You need a DevRev workspace with API access. Most DevRev plans include API access, but check your specific plan details. | ||
|
|
||
| **Q: Can multiple team members use the same MCP configuration?** | ||
| A: Each user should use their own API key for proper attribution and permissions. You can share the configuration template but not the API key. | ||
|
|
||
| **Q: Does the MCP server work offline?** | ||
| A: No, the MCP server requires internet connectivity to access DevRev APIs in real-time. |
There was a problem hiding this comment.
These should be included in the prerequisites.
| A: You'll receive authentication errors. Generate a new API key in DevRev and update your MCP configuration. | ||
|
|
||
| **Q: Can I customize which tools are available?** | ||
| A: The current version provides all tools by default. Future versions may include tool filtering options. |
There was a problem hiding this comment.
Never comment about future possibilities.
| **Q: How do I handle rate limits?** | ||
| A: The MCP server includes automatic rate limiting. If you hit limits, wait a few minutes before making more requests. |
There was a problem hiding this comment.
This should be in troubleshooting.
| ## Summary | ||
|
|
||
| The DevRev MCP server transforms how teams interact with their DevRev workspace through AI assistants. By providing seamless, real-time access to DevRev's powerful project management and customer relationship tools, teams can: | ||
|
|
||
| ✅ **Boost Productivity**: Reduce context switching between tools | ||
| ✅ **Improve Accuracy**: Access real-time data for better decision making | ||
| ✅ **Enhance Collaboration**: Share insights and updates more effectively | ||
| ✅ **Streamline Workflows**: Automate routine tasks through natural language | ||
| ✅ **Scale Operations**: Handle complex multi-step processes efficiently |
There was a problem hiding this comment.
Move this to the top of the document.
|
|
||
| --- | ||
|
|
||
| _Ready to supercharge your DevRev workflow? Get started with the setup guide above and experience the power of AI-assisted project management!_ |
There was a problem hiding this comment.
Remove since this is a technical document.
| _Ready to supercharge your DevRev workflow? Get started with the setup guide above and experience the power of AI-assisted project management!_ |
|
The content needs to be coordinated with @Vanja-S. |
|
@nimit2801, check out this https://github.com/devrev/devrev-docs-new/pull/999 raised by @Vanja-S. |
Summary
Connected Issues
Craftsmanship, Integrity, and Devil’s Advocacy
Story of the craft