@fre4x/github 1.0.40 → 1.0.42

package/README.md

@@ -1,69 +1,69 @@
-# @fre4x/github
-
-MCP server for the GitHub API. This server enables searching for repositories, code, issues, and pull requests, getting specific repository details, and creating issues.
-
-## Tools
-
-| Tool | Description |
-|---|---|
-| `github_search_repositories` | Search for GitHub repositories. Supports limit and offset. |
-| `github_search_code` | Search for code within GitHub repositories. Supports limit and offset. |
-| `github_search_issues_and_prs` | Search for issues and pull requests. Supports limit and offset. |
-| `github_get_repository` | Get details for a specific repository (owner and repo name required). |
-| `github_list_issues` | List issues in a specific repository. Supports state, limit and offset. |
-| `github_create_issue` | Create an issue in a repository. |
-| `github_get_pull_request` | Get details for a specific pull request. |
-| `github_list_pull_requests` | List pull requests in a specific repository. Supports state, limit and offset. |
-
-## Mock Mode
-
-A fully functional mock mode is available for offline testing and evaluation. It operates identically to the real API but returns static fixture data.
-
-```bash
-MOCK=true npx @fre4x/github
-```
-
-## Configuration
-
-To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
-
-```json
-{
-  "mcpServers": {
-    "github": {
-      "command": "npx",
-      "args": ["-y", "@fre4x/github"],
-      "env": {
-        "GITHUB_TOKEN": "your_personal_access_token_here"
-      }
-    }
-  }
-}
-```
-
-> **Note:** Both `GITHUB_TOKEN` and `GITHUB_PAT` are accepted. Token is optional — unauthenticated requests work but are rate-limited to 60 req/hour.
-
-Or run in mock mode:
-
-```json
-{
-  "mcpServers": {
-    "github": {
-      "command": "npx",
-      "args": ["-y", "@fre4x/github"],
-      "env": {
-        "MOCK": "true"
-      }
-    }
-  }
-}
-```
-
-## Development
-
-```bash
-npm install
-npm run dev      # tsx, no build
-npm run build    # esbuild → dist/
-npm test         # vitest unit tests
-```
+# @fre4x/github
+
+MCP server for the GitHub API. This server enables searching for repositories, code, issues, and pull requests, getting specific repository details, and creating issues.
+
+## Tools
+
+| Tool | Description |
+|---|---|
+| `github_search_repositories` | Search for GitHub repositories. Supports limit and offset. |
+| `github_search_code` | Search for code within GitHub repositories. Supports limit and offset. |
+| `github_search_issues_and_prs` | Search for issues and pull requests. Supports limit and offset. |
+| `github_get_repository` | Get details for a specific repository (owner and repo name required). |
+| `github_list_issues` | List issues in a specific repository. Supports state, limit and offset. |
+| `github_create_issue` | Create an issue in a repository. |
+| `github_get_pull_request` | Get details for a specific pull request. |
+| `github_list_pull_requests` | List pull requests in a specific repository. Supports state, limit and offset. |
+
+## Mock Mode
+
+A fully functional mock mode is available for offline testing and evaluation. It operates identically to the real API but returns static fixture data.
+
+```bash
+MOCK=true npx @fre4x/github
+```
+
+## Configuration
+
+To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "github": {
+      "command": "npx",
+      "args": ["-y", "@fre4x/github"],
+      "env": {
+        "GITHUB_TOKEN": "your_personal_access_token_here"
+      }
+    }
+  }
+}
+```
+
+> **Note:** Both `GITHUB_TOKEN` and `GITHUB_PAT` are accepted. Token is optional — unauthenticated requests work but are rate-limited to 60 req/hour.
+
+Or run in mock mode:
+
+```json
+{
+  "mcpServers": {
+    "github": {
+      "command": "npx",
+      "args": ["-y", "@fre4x/github"],
+      "env": {
+        "MOCK": "true"
+      }
+    }
+  }
+}
+```
+
+## Development
+
+```bash
+npm install
+npm run dev      # tsx, no build
+npm run build    # esbuild → dist/
+npm test         # vitest unit tests
+```