Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,44 @@ If your webhook is temporarily set to `Send me everything`, start the receiver w

### 6. Configure MCP server

Add to your Claude MCP config:
#### Option A: Claude Desktop — Desktop Extension (.mcpb)

Download `mcp-server.mcpb` from [Releases](https://github.com/Liplus-Project/github-webhook-mcp/releases), then:

1. Open Claude Desktop → **Settings** → **Extensions** → **Advanced settings** → **Install Extension...**
2. Select the `.mcpb` file
3. Enter the path to your `events.json` when prompted

#### Option B: Claude Desktop / Claude Code — npx

Add to your Claude MCP config (`claude_desktop_config.json` or project settings):

```json
{
"mcpServers": {
"github-webhook-mcp": {
"command": "npx",
"args": ["github-webhook-mcp"],
"env": {
"EVENTS_JSON_PATH": "/path/to/events.json"
}
}
}
}
```

#### Option C: Codex — config.toml

```toml
[mcp.github-webhook-mcp]
command = "npx"
args = ["github-webhook-mcp"]

[mcp.github-webhook-mcp.env]
EVENTS_JSON_PATH = "/path/to/events.json"
```

#### Option D: Python (legacy)

```json
{
Expand Down
23 changes: 14 additions & 9 deletions mcp-server/manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"manifest_version": "0.3",
"name": "github-webhook-mcp",
"version": "0.2.0",
"version": "0.2.1",
"description": "Browse pending GitHub webhook events. Pairs with a webhook receiver that writes events.json.",
"author": {
"name": "Liplus Project"
Expand All @@ -12,21 +12,22 @@
"entry_point": "server/index.js",
"mcp_config": {
"command": "node",
"args": ["${__dirname}/server/index.js"],
"args": [
"${__dirname}/server/index.js"
],
"env": {
"EVENTS_JSON_PATH": "${user_config.events_json_path}"
}
}
},
"user_config": [
{
"id": "events_json_path",
"name": "Events JSON Path",
"user_config": {
"events_json_path": {
"description": "Absolute path to the events.json file written by the webhook receiver.",
"type": "string",
"required": true
"required": true,
"title": "Events JSON Path"
}
],
},
"tools": [
{
"name": "get_pending_status",
Expand All @@ -50,6 +51,10 @@
}
],
"compatibility": {
"platforms": ["windows", "macos", "linux"]
"platforms": [
"win32",
"darwin",
"linux"
]
}
}
4 changes: 2 additions & 2 deletions mcp-server/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions mcp-server/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "github-webhook-mcp",
"version": "0.2.0",
"version": "0.2.1",
"description": "MCP server for browsing GitHub webhook events",
"type": "module",
"bin": {
"github-webhook-mcp": "./server/index.js"
"github-webhook-mcp": "server/index.js"
},
"main": "./server/index.js",
"files": [
Expand Down Expand Up @@ -35,6 +35,6 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/Liplus-Project/github-webhook-mcp.git"
"url": "git+https://github.com/Liplus-Project/github-webhook-mcp.git"
}
}
Loading