@ign8t/mcp 0.0.1 → 0.1.1
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 +65 -24
- package/dist/index.js +40 -3
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -33,7 +33,7 @@ pnpm install -g @ign8t/mcp
|
|
|
33
33
|
### 3. Configure Your AI Tool
|
|
34
34
|
|
|
35
35
|
<details>
|
|
36
|
-
<summary><strong>Cursor IDE</strong></summary>
|
|
36
|
+
<summary><strong>Cursor IDE (Recommended - using npx)</strong></summary>
|
|
37
37
|
|
|
38
38
|
Add to `~/.cursor/mcp/settings.json`:
|
|
39
39
|
|
|
@@ -41,21 +41,25 @@ Add to `~/.cursor/mcp/settings.json`:
|
|
|
41
41
|
{
|
|
42
42
|
"mcpServers": {
|
|
43
43
|
"ign8t": {
|
|
44
|
-
"command": "
|
|
45
|
-
"
|
|
46
|
-
"IGN8T_API_KEY": "your-api-key-here" // This is all you need!
|
|
47
|
-
}
|
|
44
|
+
"command": "npx",
|
|
45
|
+
"args": ["-y", "@ign8t/mcp@latest", "--api-key", "your-api-key-here"]
|
|
48
46
|
}
|
|
49
47
|
}
|
|
50
48
|
}
|
|
51
49
|
```
|
|
52
50
|
|
|
51
|
+
**Benefits of npx approach:**
|
|
52
|
+
|
|
53
|
+
- Always uses the latest version
|
|
54
|
+
- No global installation needed
|
|
55
|
+
- Cleaner configuration
|
|
56
|
+
|
|
53
57
|
Restart Cursor to activate the integration.
|
|
54
58
|
|
|
55
59
|
</details>
|
|
56
60
|
|
|
57
61
|
<details>
|
|
58
|
-
<summary><strong>Claude Desktop</strong></summary>
|
|
62
|
+
<summary><strong>Claude Desktop (Recommended - using npx)</strong></summary>
|
|
59
63
|
|
|
60
64
|
Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
|
|
61
65
|
|
|
@@ -63,10 +67,8 @@ Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
|
|
|
63
67
|
{
|
|
64
68
|
"mcpServers": {
|
|
65
69
|
"ign8t": {
|
|
66
|
-
"command": "
|
|
67
|
-
"
|
|
68
|
-
"IGN8T_API_KEY": "your-api-key-here" // This is all you need!
|
|
69
|
-
}
|
|
70
|
+
"command": "npx",
|
|
71
|
+
"args": ["-y", "@ign8t/mcp@latest", "--api-key", "your-api-key-here"]
|
|
70
72
|
}
|
|
71
73
|
}
|
|
72
74
|
}
|
|
@@ -78,6 +80,47 @@ Restart Claude Desktop to activate.
|
|
|
78
80
|
|
|
79
81
|
</details>
|
|
80
82
|
|
|
83
|
+
<details>
|
|
84
|
+
<summary><strong>Alternative: Global Installation Method</strong></summary>
|
|
85
|
+
|
|
86
|
+
If you prefer to install globally first:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
pnpm install -g @ign8t/mcp
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Then configure using command line arguments (recommended) or environment variables:
|
|
93
|
+
|
|
94
|
+
**Using arguments (recommended):**
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"mcpServers": {
|
|
99
|
+
"ign8t": {
|
|
100
|
+
"command": "ign8t-mcp",
|
|
101
|
+
"args": ["--api-key", "your-api-key-here"]
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
**Using environment variables (legacy):**
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"mcpServers": {
|
|
112
|
+
"ign8t": {
|
|
113
|
+
"command": "ign8t-mcp",
|
|
114
|
+
"env": {
|
|
115
|
+
"IGN8T_API_KEY": "your-api-key-here"
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
</details>
|
|
123
|
+
|
|
81
124
|
### 4. Verify Installation
|
|
82
125
|
|
|
83
126
|
Ask your AI assistant:
|
|
@@ -177,21 +220,22 @@ The ign8t MCP server is designed to fit seamlessly into your development workflo
|
|
|
177
220
|
|
|
178
221
|
The MCP server connects to `https://ign8t.com` by default. For enterprise deployments, self-hosted instances, or local development, you can override the API endpoint:
|
|
179
222
|
|
|
223
|
+
**Using npx (Recommended):**
|
|
224
|
+
|
|
180
225
|
```json
|
|
181
226
|
{
|
|
182
227
|
"mcpServers": {
|
|
183
228
|
"ign8t": {
|
|
184
|
-
"command": "
|
|
185
|
-
"
|
|
186
|
-
"IGN8T_API_KEY": "your-api-key",
|
|
187
|
-
"IGN8T_API_URL": "https://your-domain.com" // Optional - only for custom deployments
|
|
188
|
-
}
|
|
229
|
+
"command": "npx",
|
|
230
|
+
"args": ["-y", "@ign8t/mcp@latest", "--api-key", "your-api-key"]
|
|
189
231
|
}
|
|
190
232
|
}
|
|
191
233
|
}
|
|
192
234
|
```
|
|
193
235
|
|
|
194
|
-
|
|
236
|
+
````
|
|
237
|
+
|
|
238
|
+
**Note**: Most users don't need to set a custom API URL. It's only required if you're:
|
|
195
239
|
|
|
196
240
|
- Using an enterprise or self-hosted ign8t instance
|
|
197
241
|
- Developing locally (e.g., `http://localhost:3000`)
|
|
@@ -199,19 +243,16 @@ The MCP server connects to `https://ign8t.com` by default. For enterprise deploy
|
|
|
199
243
|
|
|
200
244
|
### Development Mode
|
|
201
245
|
|
|
202
|
-
For
|
|
246
|
+
For contributors working on the MCP server itself:
|
|
203
247
|
|
|
204
248
|
1. Clone this repository
|
|
205
249
|
2. Install dependencies: `pnpm install`
|
|
206
|
-
3.
|
|
207
|
-
4.
|
|
208
|
-
5. Configure your AI tool to use the local path
|
|
209
|
-
|
|
210
|
-
**Note**: The `.env` file is ONLY for developers working on the MCP server itself. End users should configure their API key in their IDE's MCP settings, not in `.env` files.
|
|
250
|
+
3. Build the project: `pnpm build`
|
|
251
|
+
4. Test locally: `pnpm dev --api-key your-key`
|
|
211
252
|
|
|
212
253
|
## Contributing
|
|
213
254
|
|
|
214
|
-
We welcome contributions!
|
|
255
|
+
We welcome contributions! If you'd like to contribute to the ign8t MCP server:
|
|
215
256
|
|
|
216
257
|
### Development Setup
|
|
217
258
|
|
|
@@ -228,7 +269,7 @@ pnpm test
|
|
|
228
269
|
|
|
229
270
|
# Build
|
|
230
271
|
pnpm build
|
|
231
|
-
|
|
272
|
+
````
|
|
232
273
|
|
|
233
274
|
## Support
|
|
234
275
|
|
package/dist/index.js
CHANGED
|
@@ -5,11 +5,48 @@ import { CallToolRequestSchema, ListResourcesRequestSchema, ListToolsRequestSche
|
|
|
5
5
|
import * as dotenv from "dotenv";
|
|
6
6
|
// Load environment variables
|
|
7
7
|
dotenv.config();
|
|
8
|
+
// Parse command line arguments
|
|
9
|
+
function parseArgs() {
|
|
10
|
+
const args = process.argv.slice(2);
|
|
11
|
+
const config = {};
|
|
12
|
+
for (let i = 0; i < args.length; i++) {
|
|
13
|
+
switch (args[i]) {
|
|
14
|
+
case "--api-key":
|
|
15
|
+
config.apiKey = args[i + 1];
|
|
16
|
+
i++; // Skip next argument as it's the value
|
|
17
|
+
break;
|
|
18
|
+
case "--api-url":
|
|
19
|
+
config.apiUrl = args[i + 1];
|
|
20
|
+
i++; // Skip next argument as it's the value
|
|
21
|
+
break;
|
|
22
|
+
case "--help":
|
|
23
|
+
case "-h":
|
|
24
|
+
console.log(`
|
|
25
|
+
ign8t MCP Server
|
|
26
|
+
|
|
27
|
+
Usage: ign8t-mcp --api-key <key> [--api-url <url>]
|
|
28
|
+
|
|
29
|
+
Options:
|
|
30
|
+
--api-key <key> Your ign8t API key (required)
|
|
31
|
+
--api-url <url> Custom API URL (optional, defaults to https://ign8t.com)
|
|
32
|
+
--help, -h Show this help message
|
|
33
|
+
|
|
34
|
+
Get your API key from: https://ign8t.com/settings/api-keys
|
|
35
|
+
`);
|
|
36
|
+
process.exit(0);
|
|
37
|
+
break;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return config;
|
|
41
|
+
}
|
|
8
42
|
// Configuration
|
|
9
|
-
const
|
|
10
|
-
const
|
|
43
|
+
const config = parseArgs();
|
|
44
|
+
const API_KEY = config.apiKey;
|
|
45
|
+
const API_URL = config.apiUrl || "https://ign8t.com";
|
|
11
46
|
if (!API_KEY) {
|
|
12
|
-
console.error("Error:
|
|
47
|
+
console.error("Error: API key is required");
|
|
48
|
+
console.error("Usage: ign8t-mcp --api-key <your-api-key>");
|
|
49
|
+
console.error("Or set IGN8T_API_KEY environment variable");
|
|
13
50
|
console.error("Get your API key from https://ign8t.com/settings/api-keys");
|
|
14
51
|
process.exit(1);
|
|
15
52
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ign8t/mcp",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "MCP server for ign8t project management - AI IDE integration",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -13,10 +13,15 @@
|
|
|
13
13
|
],
|
|
14
14
|
"scripts": {
|
|
15
15
|
"build": "tsc",
|
|
16
|
+
"build:watch": "tsc --watch",
|
|
16
17
|
"start": "node dist/index.js",
|
|
17
18
|
"dev": "tsx src/index.ts",
|
|
19
|
+
"dev:help": "tsx src/index.ts --help",
|
|
18
20
|
"clean": "rm -rf dist",
|
|
19
21
|
"test": "node debug-mcp.js",
|
|
22
|
+
"test:local": "node dist/index.js --help",
|
|
23
|
+
"link:local": "npm link",
|
|
24
|
+
"unlink:local": "npm unlink -g @ign8t/mcp",
|
|
20
25
|
"prepublishOnly": "pnpm clean && pnpm build"
|
|
21
26
|
},
|
|
22
27
|
"keywords": [
|