shouldideploy-today-mcp-server 0.3.0 → 0.3.4
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 +34 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
shouldideploy-today-mcp-server
|
|
2
|
-
================================
|
|
1
|
+
# shouldideploy-today-mcp-server
|
|
3
2
|
|
|
4
3
|
Simple MCP server that calls the public [`shouldideploy.today`](https://shouldideploy.today/) API to answer whether it is a good idea to deploy today.
|
|
5
4
|
|
|
@@ -8,7 +7,7 @@ Simple MCP server that calls the public [`shouldideploy.today`](https://shouldid
|
|
|
8
7
|
- **Node.js** 18+ (20+ recommended)
|
|
9
8
|
- **npm** 9+
|
|
10
9
|
|
|
11
|
-
### Installation
|
|
10
|
+
### Installation (from source)
|
|
12
11
|
|
|
13
12
|
In the project directory:
|
|
14
13
|
|
|
@@ -24,13 +23,41 @@ npm start
|
|
|
24
23
|
|
|
25
24
|
The server uses **stdio** as the transport (MCP default). Typically you do not call it directly; instead, you register it in an MCP client (such as Cursor, Claude Desktop, etc.).
|
|
26
25
|
|
|
26
|
+
### Installation via npm
|
|
27
|
+
|
|
28
|
+
Once published to npm, you can install the package globally:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm install -g shouldideploy-today-mcp-server
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
This will make the `shouldideploy-today-mcp-server` binary available on your `PATH`.
|
|
35
|
+
|
|
36
|
+
### Using with an MCP client
|
|
37
|
+
|
|
38
|
+
Below is an example configuration snippet for a generic MCP client that supports process-based servers (adjust to your client's config format):
|
|
39
|
+
|
|
40
|
+
```json
|
|
41
|
+
{
|
|
42
|
+
"mcpServers": {
|
|
43
|
+
"shouldideploy-today": {
|
|
44
|
+
"type": "stdio",
|
|
45
|
+
"command": "shouldideploy-today-mcp-server",
|
|
46
|
+
"args": []
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
After configuring and restarting your MCP client, you should see a tool named `shouldideploy_today` available.
|
|
53
|
+
|
|
27
54
|
### Available tool
|
|
28
55
|
|
|
29
|
-
- **Name**: `shouldideploy_today`
|
|
56
|
+
- **Name**: `shouldideploy_today`
|
|
30
57
|
- **Description**: Calls the `shouldideploy.today` API to check if it is a good idea to deploy today.
|
|
31
58
|
- **Input (JSON)**:
|
|
32
|
-
- `tz`
|
|
33
|
-
- `lang`
|
|
59
|
+
- `tz` _(string, optional)_: IANA timezone, for example `America/Sao_Paulo` or `UTC`. Default: `UTC`.
|
|
60
|
+
- `lang` _(string, optional)_: response language, for example `en`. Default: `en`.
|
|
34
61
|
- **Output**: plain text returned by the API, for example something like “Yes, you should deploy today” or “No, you should not deploy today”.
|
|
35
62
|
|
|
36
63
|
### How it works
|
|
@@ -45,4 +72,4 @@ The server uses **stdio** as the transport (MCP default). Typically you do not c
|
|
|
45
72
|
|
|
46
73
|
### License
|
|
47
74
|
|
|
48
|
-
This project is distributed under the MIT license. See `LICENSE` for more details.
|
|
75
|
+
This project is distributed under the MIT license. See `LICENSE` for more details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "shouldideploy-today-mcp-server",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.4",
|
|
4
4
|
"description": "Simple MCP server that calls the shouldideploy.today API to tell you whether you should deploy today.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"shouldideploy-today-mcp-server": "./dist/index.js"
|