@noushad999/github-mcp-server 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.
Files changed (2) hide show
  1. package/README.md +30 -1
  2. package/package.json +48 -38
package/README.md CHANGED
@@ -10,7 +10,8 @@
10
10
 
11
11
  **26x smaller responses than the official GitHub MCP — your Claude context window goes further.**
12
12
 
13
- [![npm](https://img.shields.io/badge/MCP-Compatible-orange?style=flat-square&logo=anthropic)](https://modelcontextprotocol.io)
13
+ [![npm](https://img.shields.io/npm/v/@noushad999/github-mcp-server?style=flat-square&logo=npm&color=cb3837)](https://www.npmjs.com/package/@noushad999/github-mcp-server)
14
+ [![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-orange?style=flat-square&logo=anthropic)](https://modelcontextprotocol.io)
14
15
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.8-3178c6?style=flat-square&logo=typescript)](https://www.typescriptlang.org)
15
16
  [![License: MIT](https://img.shields.io/badge/License-MIT-22c55e?style=flat-square)](LICENSE)
16
17
  [![Tests](https://img.shields.io/badge/Tests-49%2F49%20passing-22c55e?style=flat-square)](#testing)
@@ -52,6 +53,18 @@ Merge PR #47 with squash, delete the branch, then create a release v2.1.0 with t
52
53
 
53
54
  ## 60-Second Setup
54
55
 
56
+ **Option 1 — Run with npx (no install needed):**
57
+ ```bash
58
+ GITHUB_TOKEN=ghp_your_token npx @noushad999/github-mcp-server
59
+ ```
60
+
61
+ **Option 2 — Install globally from npm:**
62
+ ```bash
63
+ npm install -g @noushad999/github-mcp-server
64
+ github-mcp-server
65
+ ```
66
+
67
+ **Option 2 — Clone from source:**
55
68
  ```bash
56
69
  git clone https://github.com/noushad999/github-mcp-server.git
57
70
  cd github-mcp-server
@@ -61,6 +74,22 @@ echo "GITHUB_TOKEN=ghp_your_token" > .env
61
74
 
62
75
  **Claude Desktop** — edit `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/Library/Application Support/Claude/claude_desktop_config.json` (Mac):
63
76
 
77
+ **Using npx (easiest — no install needed):**
78
+ ```json
79
+ {
80
+ "mcpServers": {
81
+ "github": {
82
+ "command": "npx",
83
+ "args": ["-y", "@noushad999/github-mcp-server"],
84
+ "env": {
85
+ "GITHUB_TOKEN": "ghp_your_token_here"
86
+ }
87
+ }
88
+ }
89
+ }
90
+ ```
91
+
92
+ **Using local build:**
64
93
  ```json
65
94
  {
66
95
  "mcpServers": {
package/package.json CHANGED
@@ -1,38 +1,48 @@
1
- {
2
- "name": "@noushad999/github-mcp-server",
3
- "version": "1.0.0",
4
- "description": "Production-ready MCP server connecting Claude to GitHub — repos, PRs, issues, commits, branches & more",
5
- "main": "dist/index.js",
6
- "types": "dist/index.d.ts",
7
- "type": "module",
8
- "files": [
9
- "dist",
10
- "README.md",
11
- "LICENSE"
12
- ],
13
- "scripts": {
14
- "build": "tsc",
15
- "start": "node dist/index.js",
16
- "dev": "tsx watch src/index.ts",
17
- "lint": "eslint src/",
18
- "format": "prettier --write src/"
19
- },
20
- "keywords": ["mcp", "github", "claude", "ai", "automation", "model-context-protocol"],
21
- "license": "MIT",
22
- "publishConfig": {
23
- "access": "public"
24
- },
25
- "dependencies": {
26
- "@modelcontextprotocol/sdk": "^1.12.0",
27
- "axios": "^1.9.0",
28
- "dotenv": "^16.5.0",
29
- "zod": "^3.24.4"
30
- },
31
- "devDependencies": {
32
- "@types/node": "^22.15.0",
33
- "typescript": "^5.8.3",
34
- "tsx": "^4.19.3",
35
- "eslint": "^9.26.0",
36
- "prettier": "^3.5.3"
37
- }
38
- }
1
+ {
2
+ "name": "@noushad999/github-mcp-server",
3
+ "version": "1.0.1",
4
+ "description": "Production-ready MCP server connecting Claude to GitHub — repos, PRs, issues, commits, branches & more",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "type": "module",
8
+ "bin": {
9
+ "github-mcp-server": "dist/index.js"
10
+ },
11
+ "files": [
12
+ "dist",
13
+ "README.md",
14
+ "LICENSE"
15
+ ],
16
+ "scripts": {
17
+ "build": "tsc",
18
+ "start": "node dist/index.js",
19
+ "dev": "tsx watch src/index.ts",
20
+ "lint": "eslint src/",
21
+ "format": "prettier --write src/"
22
+ },
23
+ "keywords": [
24
+ "mcp",
25
+ "github",
26
+ "claude",
27
+ "ai",
28
+ "automation",
29
+ "model-context-protocol"
30
+ ],
31
+ "license": "MIT",
32
+ "publishConfig": {
33
+ "access": "public"
34
+ },
35
+ "dependencies": {
36
+ "@modelcontextprotocol/sdk": "^1.12.0",
37
+ "axios": "^1.9.0",
38
+ "dotenv": "^16.5.0",
39
+ "zod": "^3.24.4"
40
+ },
41
+ "devDependencies": {
42
+ "@types/node": "^22.15.0",
43
+ "typescript": "^5.8.3",
44
+ "tsx": "^4.19.3",
45
+ "eslint": "^9.26.0",
46
+ "prettier": "^3.5.3"
47
+ }
48
+ }