@fre4x/github 1.0.40 → 1.0.43

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 CHANGED
@@ -1,69 +1,69 @@
1
- # @fre4x/github
2
-
3
- MCP server for the GitHub API. This server enables searching for repositories, code, issues, and pull requests, getting specific repository details, and creating issues.
4
-
5
- ## Tools
6
-
7
- | Tool | Description |
8
- |---|---|
9
- | `github_search_repositories` | Search for GitHub repositories. Supports limit and offset. |
10
- | `github_search_code` | Search for code within GitHub repositories. Supports limit and offset. |
11
- | `github_search_issues_and_prs` | Search for issues and pull requests. Supports limit and offset. |
12
- | `github_get_repository` | Get details for a specific repository (owner and repo name required). |
13
- | `github_list_issues` | List issues in a specific repository. Supports state, limit and offset. |
14
- | `github_create_issue` | Create an issue in a repository. |
15
- | `github_get_pull_request` | Get details for a specific pull request. |
16
- | `github_list_pull_requests` | List pull requests in a specific repository. Supports state, limit and offset. |
17
-
18
- ## Mock Mode
19
-
20
- A fully functional mock mode is available for offline testing and evaluation. It operates identically to the real API but returns static fixture data.
21
-
22
- ```bash
23
- MOCK=true npx @fre4x/github
24
- ```
25
-
26
- ## Configuration
27
-
28
- To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
29
-
30
- ```json
31
- {
32
- "mcpServers": {
33
- "github": {
34
- "command": "npx",
35
- "args": ["-y", "@fre4x/github"],
36
- "env": {
37
- "GITHUB_TOKEN": "your_personal_access_token_here"
38
- }
39
- }
40
- }
41
- }
42
- ```
43
-
44
- > **Note:** Both `GITHUB_TOKEN` and `GITHUB_PAT` are accepted. Token is optional — unauthenticated requests work but are rate-limited to 60 req/hour.
45
-
46
- Or run in mock mode:
47
-
48
- ```json
49
- {
50
- "mcpServers": {
51
- "github": {
52
- "command": "npx",
53
- "args": ["-y", "@fre4x/github"],
54
- "env": {
55
- "MOCK": "true"
56
- }
57
- }
58
- }
59
- }
60
- ```
61
-
62
- ## Development
63
-
64
- ```bash
65
- npm install
66
- npm run dev # tsx, no build
67
- npm run build # esbuild → dist/
68
- npm test # vitest unit tests
69
- ```
1
+ # @fre4x/github
2
+
3
+ MCP server for the GitHub API. This server enables searching for repositories, code, issues, and pull requests, getting specific repository details, and creating issues.
4
+
5
+ ## Tools
6
+
7
+ | Tool | Description |
8
+ |---|---|
9
+ | `github_search_repositories` | Search for GitHub repositories. Supports limit and offset. |
10
+ | `github_search_code` | Search for code within GitHub repositories. Supports limit and offset. |
11
+ | `github_search_issues_and_prs` | Search for issues and pull requests. Supports limit and offset. |
12
+ | `github_get_repository` | Get details for a specific repository (owner and repo name required). |
13
+ | `github_list_issues` | List issues in a specific repository. Supports state, limit and offset. |
14
+ | `github_create_issue` | Create an issue in a repository. |
15
+ | `github_get_pull_request` | Get details for a specific pull request. |
16
+ | `github_list_pull_requests` | List pull requests in a specific repository. Supports state, limit and offset. |
17
+
18
+ ## Mock Mode
19
+
20
+ A fully functional mock mode is available for offline testing and evaluation. It operates identically to the real API but returns static fixture data.
21
+
22
+ ```bash
23
+ MOCK=true npx @fre4x/github
24
+ ```
25
+
26
+ ## Configuration
27
+
28
+ To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
29
+
30
+ ```json
31
+ {
32
+ "mcpServers": {
33
+ "github": {
34
+ "command": "npx",
35
+ "args": ["-y", "@fre4x/github"],
36
+ "env": {
37
+ "GITHUB_TOKEN": "your_personal_access_token_here"
38
+ }
39
+ }
40
+ }
41
+ }
42
+ ```
43
+
44
+ > **Note:** Both `GITHUB_TOKEN` and `GITHUB_PAT` are accepted. Token is optional — unauthenticated requests work but are rate-limited to 60 req/hour.
45
+
46
+ Or run in mock mode:
47
+
48
+ ```json
49
+ {
50
+ "mcpServers": {
51
+ "github": {
52
+ "command": "npx",
53
+ "args": ["-y", "@fre4x/github"],
54
+ "env": {
55
+ "MOCK": "true"
56
+ }
57
+ }
58
+ }
59
+ }
60
+ ```
61
+
62
+ ## Development
63
+
64
+ ```bash
65
+ npm install
66
+ npm run dev # tsx, no build
67
+ npm run build # esbuild → dist/
68
+ npm test # vitest unit tests
69
+ ```