@jorgeluismlima/teamwork-mcp 1.0.0 → 1.0.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 +27 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -37,34 +37,22 @@ Before using this MCP server, ensure you have:
|
|
|
37
37
|
* **Teamwork Account**: You must have an active Teamwork account.
|
|
38
38
|
* **API Credentials**: You need your Teamwork Site Name and an API Key (or password) to authenticate.
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## Quick Start
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
npm install
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
2. **Build the project:**
|
|
48
|
-
```bash
|
|
49
|
-
npm run build
|
|
50
|
-
```
|
|
42
|
+
You can run this server directly using `npx` without installing it globally or cloning the repository.
|
|
51
43
|
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
node dist/index.js
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## Client Configuration (Example)
|
|
44
|
+
### Client Configuration (Claude Desktop / IDEs)
|
|
58
45
|
|
|
59
|
-
To add this server to an MCP client
|
|
46
|
+
To add this server to an MCP client, simply add the following to your MCP configuration file:
|
|
60
47
|
|
|
61
48
|
```json
|
|
62
49
|
{
|
|
63
50
|
"mcpServers": {
|
|
64
51
|
"teamwork": {
|
|
65
|
-
"command": "
|
|
52
|
+
"command": "npx",
|
|
66
53
|
"args": [
|
|
67
|
-
"
|
|
54
|
+
"-y",
|
|
55
|
+
"@jorgeluismlima/teamwork-mcp"
|
|
68
56
|
],
|
|
69
57
|
"env": {
|
|
70
58
|
"TEAMWORK_SITE_NAME": "your-site-name",
|
|
@@ -76,4 +64,23 @@ To add this server to an MCP client (like Claude Desktop or an IDE extension), a
|
|
|
76
64
|
}
|
|
77
65
|
```
|
|
78
66
|
|
|
79
|
-
|
|
67
|
+
## Local Development & Installation
|
|
68
|
+
|
|
69
|
+
If you want to modify the code or run it locally from the source:
|
|
70
|
+
|
|
71
|
+
1. **Clone and Install:**
|
|
72
|
+
```bash
|
|
73
|
+
git clone <repository-url>
|
|
74
|
+
cd teamwork-mcp
|
|
75
|
+
npm install
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
2. **Build the project:**
|
|
79
|
+
```bash
|
|
80
|
+
npm run build
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
3. **Run the server:**
|
|
84
|
+
```bash
|
|
85
|
+
node dist/index.js
|
|
86
|
+
```
|