Skip to content

Commit 979eea1

Browse files
committed
docs: update README with Linear integration and expanded tool documentation
- Add Linear MCP server package to available packages section - Include Linear integration configuration instructions - Provide Linear command usage examples - Update documentation links and structure - Enhance troubleshooting section for multiple service integrations
1 parent f72ed89 commit 979eea1

File tree

1 file changed

+56
-14
lines changed

1 file changed

+56
-14
lines changed

README.md

Lines changed: 56 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,24 @@ MCP (Model Context Protocol) DevTools is a collection of packages that enable AI
1010
- 🔌 **Seamless Integration**: Connect AI assistants to external services and tools
1111
- 🛠 **Extensible Framework**: Easily create new integrations with the Model Context Protocol
1212
- 🔍 **Powerful Interactions**: Enable AI to access and manipulate data from external services
13-
- 📊 **Jira Integration**: Robust Jira integration with comprehensive functionality
13+
- 📊 **Robust Integrations**: Comprehensive functionality for Jira and Linear
1414
- 🚀 **Developer-Friendly**: Simple setup with detailed documentation for the best developer experience
1515

1616
> **Note**: This project is currently in beta (0.x.x versions). APIs may change between minor versions during the beta phase.
1717
1818
## 📦 Available Packages
1919

20-
| Package | Description | Status |
21-
| ----------------------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
22-
| [@mcp-devtools/jira](./packages/jira/README.md) | Jira MCP server integration | [![npm version](https://img.shields.io/npm/v/@mcp-devtools/jira.svg)](https://www.npmjs.com/package/@mcp-devtools/jira) |
20+
| Package | Description | Status |
21+
| --------------------------------------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
22+
| [@mcp-devtools/jira](./packages/jira/README.md) | Jira MCP server integration | [![npm version](https://img.shields.io/npm/v/@mcp-devtools/jira.svg)](https://www.npmjs.com/package/@mcp-devtools/jira) |
23+
| [@mcp-devtools/linear](./packages/linear/README.md) | Linear MCP server integration | [![npm version](https://img.shields.io/npm/v/@mcp-devtools/linear.svg)](https://www.npmjs.com/package/@mcp-devtools/linear) |
2324

2425
## 🚀 Quick Start
2526

2627
### Configuration in Cursor IDE
2728

29+
#### Jira Integration
30+
2831
1. Open Cursor Settings → MCP
2932
2. Click "Add New MCP Server"
3033
3. Fill in the following details:
@@ -39,9 +42,25 @@ MCP (Model Context Protocol) DevTools is a collection of packages that enable AI
3942
> - `JIRA_API_MAIL`: Your Atlassian account email
4043
> - `JIRA_API_KEY`: Your Atlassian API key ([Create one here](https://id.atlassian.com/manage-profile/security/api-tokens))
4144
42-
### Using Jira Tools
45+
#### Linear Integration
46+
47+
1. Open Cursor Settings → MCP
48+
2. Click "Add New MCP Server"
49+
3. Fill in the following details:
50+
- **Name**: `Linear`
51+
- **Type**: `command`
52+
- **Command**:
53+
`env LINEAR_API_KEY=[YOUR_API_KEY] npx -y @mcp-devtools/linear`
54+
55+
> **Required Environment Variables**:
56+
>
57+
> - `LINEAR_API_KEY`: Your Linear API key (Create one in Linear app: Settings → API → Create Key)
58+
59+
### Using Tools
4360

44-
Once configured, you can interact with Jira through natural language commands in Cursor. Examples:
61+
Once configured, you can interact with tools through natural language commands in Cursor.
62+
63+
#### Jira Examples:
4564

4665
```
4766
# Fetch a specific ticket
@@ -57,11 +76,31 @@ read ticket SCRUM-123
5776
create ticket project=SCRUM summary="Fix login bug" description="Users can't log in" issuetype=Bug
5877
```
5978

60-
For a complete list of available commands, refer to the [Jira Package Documentation](./packages/jira/README.md).
79+
#### Linear Examples:
80+
81+
```
82+
# Get a specific issue
83+
get_issue SS-33
84+
85+
# Search for issues
86+
search_issues "priority is high" with limit 5
87+
88+
# Create a new issue
89+
create_issue for team "eng" titled "Fix API response format" with description "The API is returning incorrect data format" and priority 1
90+
91+
# List teams
92+
list_teams
93+
```
94+
95+
For a complete list of available commands, refer to the package documentation:
96+
97+
- [Jira Package Documentation](./packages/jira/README.md)
98+
- [Linear Package Documentation](./packages/linear/README.md)
6199

62100
## 📖 Documentation
63101

64102
- [Jira Package Documentation](./packages/jira/README.md)
103+
- [Linear Package Documentation](./packages/linear/README.md)
65104
- [Getting Started Guide](./docs/getting-started.md)
66105
- [Contributing Guidelines](./CONTRIBUTING.md)
67106

@@ -74,7 +113,9 @@ mcp-devtools/
74113
│ └── http-client/ # HTTP client utilities
75114
76115
├── packages/ # Functional MCP server packages
77-
│ └── jira/ # Jira integration MCP server
116+
│ ├── jira/ # Jira integration MCP server
117+
│ │ └── README.md # Package documentation
118+
│ └── linear/ # Linear integration MCP server
78119
│ └── README.md # Package documentation
79120
80121
└── ...
@@ -115,7 +156,8 @@ mcp-devtools/
115156
│ └── http-client/ # HTTP client utilities
116157
117158
├── packages/ # Functional MCP server packages
118-
│ └── jira/ # Jira integration MCP server
159+
│ ├── jira/ # Jira integration MCP server
160+
│ └── linear/ # Linear integration MCP server
119161
├── package.json # Root package configuration
120162
└── pnpm-workspace.yaml # Workspace configuration
121163
```
@@ -230,14 +272,14 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
230272

231273
1. **Connection Problems**
232274

233-
- Ensure your Jira API credentials are correct
234-
- Check network connectivity to your Jira instance
235-
- Verify that the JIRA_URL includes the correct workspace name
275+
- Ensure your API credentials are correct
276+
- Check network connectivity to your service instances
277+
- Verify URLs and workspace names
236278

237279
2. **Permission Errors**
238280

239-
- Ensure your Jira account has appropriate permissions for the actions you're attempting
240-
- API tokens may need specific permissions enabled in your Atlassian account
281+
- Ensure your accounts have appropriate permissions for the actions you're attempting
282+
- API tokens may need specific permissions enabled in your account settings
241283

242284
3. **Command Not Found**
243285
- If using npx, ensure you're connected to npm registry

0 commit comments

Comments
 (0)