Skip to content

Commit f67fad3

Browse files
authored
Merge pull request #12 from DXHeroes/test/release
fix: update README with Jira MCP server configuration and usage instr…
2 parents 852ce18 + 4c6d7f5 commit f67fad3

File tree

4 files changed

+43
-50
lines changed

4 files changed

+43
-50
lines changed

.github/workflows/npm-publish.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

README.md

Lines changed: 43 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,6 @@ These core packages are for internal use only and are not published to npm.
2323

2424
Only the MCP server packages under the `@mcp-devtools` scope are published to npm.
2525

26-
## Project Structure
27-
28-
```
29-
mcp-devtools/
30-
├── core/ # Infrastructure and utility packages
31-
│ ├── typescript-config/ # Shared TypeScript configuration
32-
│ └── http-client/ # HTTP client utilities
33-
34-
├── packages/ # Functional MCP server packages
35-
│ └── jira/ # Jira integration MCP server
36-
├── package.json # Root package configuration
37-
└── pnpm-workspace.yaml # Workspace configuration
38-
```
39-
4026
## Using MCP Tools
4127

4228
MCP tools in this repository can be integrated with AI assistants that support the Model Context Protocol. Here's how to use them in different environments:
@@ -45,12 +31,49 @@ MCP tools in this repository can be integrated with AI assistants that support t
4531

4632
To use MCP tools with Cursor IDE:
4733

48-
1. Install the desired MCP package locally or globally
49-
2. Configure the MCP server in Cursor settings
50-
3. Access the tool functionality directly through the Cursor IDE interface
34+
1. Configure the MCP server in Cursor settings
35+
2. Access the tool functionality directly through the Cursor IDE chat
36+
37+
#### Jira
38+
39+
1. MCP Server Configuration
40+
41+
Go to Cursor Settings > MCP > Add new MCP server
42+
43+
- Server name: `Jira`
44+
- Type: `command`
45+
- Command:
46+
47+
```bash
48+
env JIRA_URL=https://[YOUR_WORKSPACE].atlassian.net JIRA_API_MAIL=[YOUR_EMAIL] JIRA_API_KEY=[YOUR_API_KEY] npx @mcp-devtools/jira
49+
```
50+
51+
2. Usage in chat
52+
53+
```bash
54+
get task [ticket id]
55+
# example
56+
get task SCRUM-1
57+
```
5158

5259
For specific tool configuration instructions, refer to the README in each package directory.
5360

61+
## Project Structure
62+
63+
```
64+
65+
mcp-devtools/
66+
├── core/ # Infrastructure and utility packages
67+
│ ├── typescript-config/ # Shared TypeScript configuration
68+
│ └── http-client/ # HTTP client utilities
69+
70+
├── packages/ # Functional MCP server packages
71+
│ └── jira/ # Jira integration MCP server
72+
├── package.json # Root package configuration
73+
└── pnpm-workspace.yaml # Workspace configuration
74+
75+
```
76+
5477
## Development
5578

5679
### Getting Started
@@ -61,9 +84,10 @@ This repository uses pnpm workspaces for package management. To get started:
6184

6285
```bash
6386
npm install -g pnpm
64-
6587
```
6688

89+
````
90+
6791
2. Install dependencies:
6892
6993
```bash
@@ -237,3 +261,4 @@ BREAKING CHANGE: The http-client API has been completely redesigned to improve u
237261
## License
238262
239263
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
264+
````

core/http-client/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"name": "@mcp-devtools/http-client",
33
"version": "0.1.0",
44
"description": "Simple HTTP client for MCP servers",
5-
"private": true,
65
"type": "module",
76
"main": "src/index.ts",
87
"types": "src/types.ts",

core/typescript-config/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"name": "@mcp-devtools/typescript-config",
33
"version": "0.1.0",
44
"description": "Shared TypeScript configuration for MCP projects",
5-
"private": true,
65
"type": "module",
76
"main": "tsconfig.base.json",
87
"files": ["tsconfig.*.json"],

0 commit comments

Comments
 (0)