@shortcut/mcp 0.1.5 → 0.2.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 +52 -3
- package/dist/index.js +573 -550
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -51,16 +51,65 @@ See the [official Cursor docs](https://docs.cursor.com/context/model-context-pro
|
|
|
51
51
|
}
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
+
## Issues and Troubleshooting
|
|
55
|
+
|
|
56
|
+
If you run into problems using this MCP server, you have a couple of options:
|
|
57
|
+
|
|
58
|
+
- Open an issue on [GitHub](https://github.com/useshortcut/mcp-server-shortcut/issues)
|
|
59
|
+
- Ask for help in the community [Slack](https://shortcut.com/join-slack)
|
|
60
|
+
|
|
61
|
+
You can also check the list of [common issues](#common-issues) below to see if there is a known solution already.
|
|
62
|
+
|
|
63
|
+
### Common Issues and Solutions
|
|
64
|
+
|
|
65
|
+
#### NPX command not working when using MISE for version management
|
|
66
|
+
|
|
67
|
+
If you are using MISE for managing Node and NPM versions, you may encounter a "Client closed" error when trying to run the MCP server. Installing this extension into your IDE might help: https://github.com/hverlin/mise-vscode/.
|
|
68
|
+
|
|
54
69
|
## Development
|
|
55
70
|
|
|
56
|
-
|
|
71
|
+
### Installation
|
|
57
72
|
|
|
58
73
|
```bash
|
|
59
74
|
npm install
|
|
60
75
|
```
|
|
61
76
|
|
|
62
|
-
|
|
77
|
+
### Build
|
|
63
78
|
|
|
64
79
|
```bash
|
|
65
80
|
npm run build
|
|
66
|
-
```
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Running the Development Server Locally
|
|
84
|
+
|
|
85
|
+
To test your local development version of the MCP server rather than using the published package, follow these steps:
|
|
86
|
+
|
|
87
|
+
1. Build the project:
|
|
88
|
+
```bash
|
|
89
|
+
npm run build
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
2. Create or modify your `mcp.json` file to reference your local build:
|
|
93
|
+
```json
|
|
94
|
+
{
|
|
95
|
+
"mcpServers": {
|
|
96
|
+
"shortcut": {
|
|
97
|
+
"command": "node",
|
|
98
|
+
"args": [
|
|
99
|
+
"/path/to/your/local/mcp-server-shortcut/dist/index.js"
|
|
100
|
+
],
|
|
101
|
+
"env": {
|
|
102
|
+
"SHORTCUT_API_TOKEN": "<YOUR_SHORTCUT_API_TOKEN>"
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
3. Place this `mcp.json` file in one of the following locations:
|
|
110
|
+
- For Cursor: In your home directory (`~/.cursor/mcp.json`) or in your project directory (`.cursor/mcp.json`)
|
|
111
|
+
- For Windsurf: Use the MCP Configuration Panel to add the custom server
|
|
112
|
+
|
|
113
|
+
4. Restart your AI assistant (Cursor or Windsurf) to load the new configuration.
|
|
114
|
+
|
|
115
|
+
This allows you to instantly test changes to the MCP server without having to publish a new version.
|