@bretwardjames/ghp-mcp 0.1.0-beta.0
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/.turbo/turbo-build.log +15 -0
- package/CHANGELOG.md +12 -0
- package/README.md +112 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1621 -0
- package/package.json +47 -0
- package/src/auth/token-provider.ts +38 -0
- package/src/context/repo-context.ts +67 -0
- package/src/index.ts +44 -0
- package/src/resources/index.ts +17 -0
- package/src/resources/issue.ts +112 -0
- package/src/resources/plan.ts +120 -0
- package/src/resources/projects.ts +81 -0
- package/src/resources/work.ts +98 -0
- package/src/server.ts +44 -0
- package/src/tools/add-issue.ts +132 -0
- package/src/tools/assign.ts +87 -0
- package/src/tools/comment.ts +83 -0
- package/src/tools/done.ts +134 -0
- package/src/tools/index.ts +32 -0
- package/src/tools/move.ts +135 -0
- package/src/tools/plan.ts +170 -0
- package/src/tools/set-field.ts +124 -0
- package/src/tools/start.ts +152 -0
- package/src/tools/update-issue.ts +142 -0
- package/src/tools/work.ts +166 -0
- package/tsconfig.json +21 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
> @bretwardjames/ghp-mcp@0.1.0-beta.0 build /home/bretwardjames/IdeaProjects/ghp/packages/mcp
|
|
4
|
+
> tsup src/index.ts --format esm --dts
|
|
5
|
+
|
|
6
|
+
[34mCLI[39m Building entry: src/index.ts
|
|
7
|
+
[34mCLI[39m Using tsconfig: tsconfig.json
|
|
8
|
+
[34mCLI[39m tsup v8.5.1
|
|
9
|
+
[34mCLI[39m Target: es2022
|
|
10
|
+
[34mESM[39m Build start
|
|
11
|
+
[32mESM[39m [1mdist/index.js [22m[32m44.77 KB[39m
|
|
12
|
+
[32mESM[39m ⚡️ Build success in 26ms
|
|
13
|
+
DTS Build start
|
|
14
|
+
DTS ⚡️ Build success in 858ms
|
|
15
|
+
DTS dist/index.d.ts 20.00 B
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# @bretwardjames/ghp-mcp
|
|
2
|
+
|
|
3
|
+
## 0.1.0-beta.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Adds non-interactive support for CLI commands, as well as a full MCP server for configuring AI agents to work directly with the CLI.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @bretwardjames/ghp-core@0.2.0-beta.0
|
package/README.md
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# @bretwardjames/ghp-mcp
|
|
2
|
+
|
|
3
|
+
MCP server for GitHub Projects - exposes GitHub Projects functionality to AI assistants via the [Model Context Protocol](https://modelcontextprotocol.io).
|
|
4
|
+
|
|
5
|
+
Part of the [GHP monorepo](https://github.com/bretwardjames/ghp). Works alongside the [CLI](https://github.com/bretwardjames/ghp/tree/main/packages/cli) and [VS Code extension](https://github.com/bretwardjames/ghp/tree/main/apps/vscode).
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @bretwardjames/ghp-mcp
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Configuration
|
|
14
|
+
|
|
15
|
+
### Quick Setup (Recommended)
|
|
16
|
+
|
|
17
|
+
**From CLI:**
|
|
18
|
+
```bash
|
|
19
|
+
ghp mcp --install
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**From VS Code/Cursor:**
|
|
23
|
+
Open Command Palette → "GitHub Projects: Install MCP Server for Claude Desktop"
|
|
24
|
+
|
|
25
|
+
Both methods automatically configure Claude Desktop for you.
|
|
26
|
+
|
|
27
|
+
### Manual Configuration
|
|
28
|
+
|
|
29
|
+
If you prefer to configure manually, add this to your Claude Desktop config file:
|
|
30
|
+
|
|
31
|
+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
32
|
+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
33
|
+
**Linux**: `~/.config/Claude/claude_desktop_config.json`
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"mcpServers": {
|
|
38
|
+
"ghp": {
|
|
39
|
+
"command": "ghp-mcp"
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Or with npx (no global install required):
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"mcpServers": {
|
|
50
|
+
"ghp": {
|
|
51
|
+
"command": "npx",
|
|
52
|
+
"args": ["@bretwardjames/ghp-mcp"]
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
After configuring, restart Claude Desktop to load the MCP server.
|
|
59
|
+
|
|
60
|
+
### Authentication
|
|
61
|
+
|
|
62
|
+
The server uses the same GitHub authentication as the CLI. Run `ghp auth` to authenticate, or set a `GITHUB_TOKEN` environment variable.
|
|
63
|
+
|
|
64
|
+
## Tools
|
|
65
|
+
|
|
66
|
+
| Tool | Description |
|
|
67
|
+
|------|-------------|
|
|
68
|
+
| `work` | View items assigned to you |
|
|
69
|
+
| `get_project_board` | View project board/items (with optional status/assignee filters) |
|
|
70
|
+
| `create_issue` | Create a new issue and add to project |
|
|
71
|
+
| `update_issue` | Update an issue's title and/or body |
|
|
72
|
+
| `move` | Move an issue to a different status |
|
|
73
|
+
| `done` | Mark an issue as done |
|
|
74
|
+
| `start` | Start working on an issue |
|
|
75
|
+
| `assign` | Assign users to an issue |
|
|
76
|
+
| `comment` | Add a comment to an issue |
|
|
77
|
+
| `set_field` | Set a field value on an issue |
|
|
78
|
+
|
|
79
|
+
### Example Usage
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
AI: "Show me my current work items"
|
|
83
|
+
→ Uses the `work` tool
|
|
84
|
+
|
|
85
|
+
AI: "Create a bug report for the login timeout issue"
|
|
86
|
+
→ Uses `create_issue` with appropriate title/body
|
|
87
|
+
|
|
88
|
+
AI: "Move issue 42 to In Review"
|
|
89
|
+
→ Uses `move` tool
|
|
90
|
+
|
|
91
|
+
AI: "Start working on issue 15"
|
|
92
|
+
→ Uses `start` tool (creates branch, updates status)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Resources
|
|
96
|
+
|
|
97
|
+
| Resource | Description |
|
|
98
|
+
|----------|-------------|
|
|
99
|
+
| `work://items` | Your assigned work items |
|
|
100
|
+
| `plan://board` | Full project board view |
|
|
101
|
+
| `issue://{number}` | Single issue details |
|
|
102
|
+
| `projects://list` | Available projects |
|
|
103
|
+
|
|
104
|
+
## Requirements
|
|
105
|
+
|
|
106
|
+
- Node.js >= 18
|
|
107
|
+
- GitHub account with Projects access
|
|
108
|
+
- `ghp auth` completed or `GITHUB_TOKEN` environment variable
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
MIT
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|