@ric_/forgejo-mcp 0.1.0 → 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 +30 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,12 +20,12 @@ A Model Context Protocol (MCP) server for [Forgejo](https://forgejo.org/) and [G
|
|
|
20
20
|
### Installation
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
npm install -g forgejo-mcp
|
|
23
|
+
npm install -g @ric_/forgejo-mcp
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
Or run directly:
|
|
27
27
|
```bash
|
|
28
|
-
npx forgejo-mcp
|
|
28
|
+
npx @ric_/forgejo-mcp
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
### Configuration
|
|
@@ -38,19 +38,28 @@ export FORGEJO_TOKEN=your-api-token
|
|
|
38
38
|
|
|
39
39
|
Or pass as CLI args:
|
|
40
40
|
```bash
|
|
41
|
-
forgejo-mcp --url https://your-instance.com --token your-token
|
|
41
|
+
npx @ric_/forgejo-mcp --url https://your-instance.com --token your-token
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
## Usage
|
|
45
45
|
|
|
46
46
|
### With Claude Code
|
|
47
|
-
|
|
47
|
+
You can add the MCP server using the CLI:
|
|
48
|
+
```bash
|
|
49
|
+
claude mcp add-json forgejo '{"command":"npx","args":["@ric_/forgejo-mcp"],"env":{"FORGEJO_URL":"https://your-instance.com","FORGEJO_TOKEN":"your-token"}}'
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Or manually edit the config file:
|
|
53
|
+
- **Project scope** (shared with team): `.mcp.json` in your project root
|
|
54
|
+
- **User scope** (personal, all projects): `~/.claude.json`
|
|
55
|
+
|
|
56
|
+
Add the following to the `mcpServers` object:
|
|
48
57
|
```json
|
|
49
58
|
{
|
|
50
59
|
"mcpServers": {
|
|
51
60
|
"forgejo": {
|
|
52
61
|
"command": "npx",
|
|
53
|
-
"args": ["forgejo-mcp"],
|
|
62
|
+
"args": ["@ric_/forgejo-mcp"],
|
|
54
63
|
"env": {
|
|
55
64
|
"FORGEJO_URL": "https://your-instance.com",
|
|
56
65
|
"FORGEJO_TOKEN": "your-token"
|
|
@@ -60,6 +69,8 @@ Add to your Claude Code MCP config:
|
|
|
60
69
|
}
|
|
61
70
|
```
|
|
62
71
|
|
|
72
|
+
You can verify the server is connected by running `/mcp` inside Claude Code.
|
|
73
|
+
|
|
63
74
|
### With Claude Desktop
|
|
64
75
|
Add to claude_desktop_config.json:
|
|
65
76
|
```json
|
|
@@ -67,7 +78,7 @@ Add to claude_desktop_config.json:
|
|
|
67
78
|
"mcpServers": {
|
|
68
79
|
"forgejo": {
|
|
69
80
|
"command": "npx",
|
|
70
|
-
"args": ["forgejo-mcp"],
|
|
81
|
+
"args": ["@ric_/forgejo-mcp"],
|
|
71
82
|
"env": {
|
|
72
83
|
"FORGEJO_URL": "https://your-instance.com",
|
|
73
84
|
"FORGEJO_TOKEN": "your-token"
|
|
@@ -83,7 +94,7 @@ For remote/shared access:
|
|
|
83
94
|
FORGEJO_URL=https://your-instance.com \
|
|
84
95
|
FORGEJO_TOKEN=your-token \
|
|
85
96
|
FORGEJO_MCP_API_KEY=your-secret-api-key \
|
|
86
|
-
npx forgejo-mcp-http --port 3000
|
|
97
|
+
npx @ric_/forgejo-mcp-http --port 3000
|
|
87
98
|
```
|
|
88
99
|
Endpoint: `http://localhost:3000/mcp`
|
|
89
100
|
|
|
@@ -94,14 +105,23 @@ Endpoint: `http://localhost:3000/mcp`
|
|
|
94
105
|
- `RATE_LIMIT_WINDOW_MS` - window size in milliseconds (default: 60000)
|
|
95
106
|
|
|
96
107
|
### Docker
|
|
108
|
+
Pull from Docker Hub:
|
|
109
|
+
```bash
|
|
110
|
+
docker run -p 3000:3000 \
|
|
111
|
+
-e FORGEJO_URL=https://your-instance.com \
|
|
112
|
+
-e FORGEJO_TOKEN=your-token \
|
|
113
|
+
-e FORGEJO_MCP_API_KEY=your-secret-key \
|
|
114
|
+
richarvey/forgejo-mcp
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Or use docker-compose:
|
|
97
118
|
```bash
|
|
98
|
-
# Build and run with docker-compose
|
|
99
119
|
cp .env.example .env
|
|
100
120
|
# Edit .env with your values, then:
|
|
101
121
|
docker compose up -d
|
|
102
122
|
```
|
|
103
123
|
|
|
104
|
-
Or build
|
|
124
|
+
Or build from source:
|
|
105
125
|
```bash
|
|
106
126
|
docker build -t forgejo-mcp .
|
|
107
127
|
docker run -p 3000:3000 \
|
|
@@ -276,7 +296,7 @@ The Docker image:
|
|
|
276
296
|
## Development
|
|
277
297
|
|
|
278
298
|
```bash
|
|
279
|
-
git clone https://
|
|
299
|
+
git clone https://code.squarecows.com/SquareCows/forgejo-mcp.git
|
|
280
300
|
cd forgejo-mcp
|
|
281
301
|
npm install
|
|
282
302
|
npm run dev # stdio mode
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ric_/forgejo-mcp",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "A Model Context Protocol (MCP) server for Forgejo and Gitea instances. Provides 102 tools across repos, issues, PRs, orgs, users, and admin APIs. Works with Claude, Cursor, and any MCP-compatible client. Supports stdio and HTTP transports. Built with Claude Code.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|