@aaronsb/jira-cloud-mcp 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,70 @@
1
+ # Jira Cloud MCP Server
2
+
3
+ A Model Context Protocol server for interacting with Jira Cloud instances.
4
+
5
+ ## Quick Start
6
+
7
+ ### Installation
8
+
9
+ Add to your MCP settings:
10
+
11
+ ```json
12
+ {
13
+ "mcpServers": {
14
+ "jira-cloud": {
15
+ "command": "npx",
16
+ "args": ["-y", "@aaronsb/jira-cloud-mcp"],
17
+ "env": {
18
+ "JIRA_API_TOKEN": "your-api-token",
19
+ "JIRA_EMAIL": "your-email",
20
+ "JIRA_HOST": "your-team.atlassian.net"
21
+ }
22
+ }
23
+ }
24
+ }
25
+ ```
26
+
27
+ Or install globally:
28
+
29
+ ```bash
30
+ npm install -g @aaronsb/jira-cloud-mcp
31
+ ```
32
+
33
+ For detailed installation instructions, see the [Getting Started Guide](./docs/getting-started.md).
34
+
35
+ ## Key Features
36
+
37
+ - **Issue Management**: Create, retrieve, update, and comment on Jira issues
38
+ - **Search Capabilities**: JQL search with filtering
39
+ - **Project & Board Management**: List and manage projects, boards, and sprints
40
+ - **MCP Resources**: Access Jira data as context through MCP resources
41
+ - **Tool Documentation**: Comprehensive documentation for each tool available as MCP resources
42
+ - **Customization**: Support for custom fields and workflows
43
+
44
+ ## Architecture
45
+
46
+ The server is built with a modular architecture:
47
+
48
+ ```
49
+ src/
50
+ ├── client/ # Core Jira API client
51
+ ├── handlers/ # MCP tool handlers
52
+ ├── schemas/ # JSON schemas for tools
53
+ ├── types/ # TypeScript definitions
54
+ ├── utils/ # Utility functions
55
+ └── index.ts # Server entry point
56
+ ```
57
+
58
+ ## Documentation
59
+
60
+ Essential documentation is available in the `docs/` directory:
61
+
62
+ - [Getting Started](./docs/getting-started.md) - Setup and installation
63
+ - [API Reference](./docs/api-reference.md) - Available tools and usage
64
+ - [Resources](./docs/resources.md) - Available MCP resources
65
+ - [Troubleshooting](./docs/troubleshooting.md) - Common issues and solutions
66
+ - [Development](./docs/development.md) - Development guide
67
+
68
+ ## License
69
+
70
+ [MIT License](LICENSE)