octocode-mcp 11.2.2 → 12.1.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/README.md +8 -8
- package/dist/index.d.ts +74 -0
- package/dist/index.js +142 -140
- package/dist/public.d.ts +1336 -1122
- package/dist/public.js +140 -139
- package/package.json +27 -34
- package/dist/public.d.ts.map +0 -1
- package/dist/public.js.map +0 -1
- package/dist/responses.d.ts +0 -244
- package/dist/responses.d.ts.map +0 -1
- package/dist/responses.js +0 -72
- package/dist/responses.js.map +0 -1
package/README.md
CHANGED
|
@@ -158,7 +158,7 @@ This will automatically:
|
|
|
158
158
|
curl -fsSL https://raw.githubusercontent.com/bgauryy/octocode-mcp/main/install/install.sh | sh
|
|
159
159
|
```
|
|
160
160
|
|
|
161
|
-
|
|
161
|
+
See [Troubleshooting Guide](https://github.com/bgauryy/octocode-mcp/blob/main/docs/TROUBLESHOOTING.md) for common issues and solutions.
|
|
162
162
|
|
|
163
163
|
---
|
|
164
164
|
|
|
@@ -166,7 +166,7 @@ curl -fsSL https://raw.githubusercontent.com/bgauryy/octocode-mcp/main/install/i
|
|
|
166
166
|
|
|
167
167
|
#### Prerequisites
|
|
168
168
|
|
|
169
|
-
- **Node.js** >=
|
|
169
|
+
- **Node.js** >= 20.0.0
|
|
170
170
|
- **GitHub Authentication** (choose one):
|
|
171
171
|
- **GitHub CLI (recommended)**: Install from [cli.github.com](https://cli.github.com/) and run `gh auth login`
|
|
172
172
|
- **Personal Access Token**: Create at [github.com/settings/tokens](https://github.com/settings/tokens) with scopes: `repo`, `read:user`, `read:org`
|
|
@@ -544,7 +544,7 @@ Add the `GITHUB_API_URL` environment variable to your MCP configuration:
|
|
|
544
544
|
|
|
545
545
|
**Default:** If not specified, defaults to `https://api.github.com` (public GitHub).
|
|
546
546
|
|
|
547
|
-
**Note:** Ensure your GitHub Enterprise token has the same scopes as documented in the [Authentication
|
|
547
|
+
**Note:** Ensure your GitHub Enterprise token has the same scopes as documented in the [Authentication Setup](./docs/AUTHENTICATION_SETUP.md).
|
|
548
548
|
|
|
549
549
|
---
|
|
550
550
|
|
|
@@ -680,9 +680,9 @@ Comprehensive security analysis of a repository. Identifies vulnerabilities, rev
|
|
|
680
680
|
| Resource | Description | Link |
|
|
681
681
|
|----------|-------------|------|
|
|
682
682
|
| **Official Website** | Interactive tutorials, demos, community | [octocode.ai](https://octocode.ai) |
|
|
683
|
-
| **
|
|
684
|
-
| **
|
|
685
|
-
| **
|
|
683
|
+
| **Configuration Guide** | Environment variables and server configuration | [CONFIGURATION_REFERENCE.md](https://github.com/bgauryy/octocode-mcp/blob/main/docs/CONFIGURATION_REFERENCE.md) |
|
|
684
|
+
| **Authentication Guide** | Setup instructions for GitHub & GitLab | [Authentication Setup](./docs/AUTHENTICATION_SETUP.md) |
|
|
685
|
+
| **Troubleshooting** | Common issues and solutions | [Troubleshooting Guide](https://github.com/bgauryy/octocode-mcp/blob/main/docs/TROUBLESHOOTING.md) |
|
|
686
686
|
| **YouTube Channel** | Video tutorials and demonstrations | [Octocode on YouTube](https://www.youtube.com/@Octocode-ai) |
|
|
687
687
|
|
|
688
688
|
|
|
@@ -716,10 +716,10 @@ Octocode collects **de-identified** telemetry data to improve the tool, includin
|
|
|
716
716
|
You can opt-out at any time:
|
|
717
717
|
|
|
718
718
|
```bash
|
|
719
|
-
export
|
|
719
|
+
export LOG=false
|
|
720
720
|
```
|
|
721
721
|
|
|
722
|
-
For full details, please read our [Privacy Policy](
|
|
722
|
+
For full details, please read our [Privacy Policy](https://github.com/bgauryy/octocode-mcp/blob/main/PRIVACY.md) and [Terms of Usage](https://github.com/bgauryy/octocode-mcp/blob/main/TERMS.md).
|
|
723
723
|
|
|
724
724
|
---
|
|
725
725
|
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
|
+
|
|
4
|
+
//#region src/types/metadata.d.ts
|
|
5
|
+
|
|
6
|
+
interface ToolMetadata {
|
|
7
|
+
name: string;
|
|
8
|
+
description: string;
|
|
9
|
+
schema: Record<string, string>;
|
|
10
|
+
outputSchema?: Record<string, unknown>;
|
|
11
|
+
hints: {
|
|
12
|
+
hasResults: readonly string[];
|
|
13
|
+
empty: readonly string[];
|
|
14
|
+
dynamic?: Record<string, string[] | undefined>;
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
interface PromptArgument {
|
|
18
|
+
name: string;
|
|
19
|
+
description: string;
|
|
20
|
+
required?: boolean;
|
|
21
|
+
}
|
|
22
|
+
interface PromptMetadata {
|
|
23
|
+
name: string;
|
|
24
|
+
description: string;
|
|
25
|
+
content: string;
|
|
26
|
+
args?: PromptArgument[];
|
|
27
|
+
}
|
|
28
|
+
interface ToolNames {
|
|
29
|
+
GITHUB_FETCH_CONTENT: 'githubGetFileContent';
|
|
30
|
+
GITHUB_SEARCH_CODE: 'githubSearchCode';
|
|
31
|
+
GITHUB_SEARCH_PULL_REQUESTS: 'githubSearchPullRequests';
|
|
32
|
+
GITHUB_SEARCH_REPOSITORIES: 'githubSearchRepositories';
|
|
33
|
+
GITHUB_VIEW_REPO_STRUCTURE: 'githubViewRepoStructure';
|
|
34
|
+
GITHUB_CLONE_REPO: 'githubCloneRepo';
|
|
35
|
+
PACKAGE_SEARCH: 'packageSearch';
|
|
36
|
+
LOCAL_RIPGREP: 'localSearchCode';
|
|
37
|
+
LOCAL_FETCH_CONTENT: 'localGetFileContent';
|
|
38
|
+
LOCAL_FIND_FILES: 'localFindFiles';
|
|
39
|
+
LOCAL_VIEW_STRUCTURE: 'localViewStructure';
|
|
40
|
+
LSP_GOTO_DEFINITION: 'lspGotoDefinition';
|
|
41
|
+
LSP_FIND_REFERENCES: 'lspFindReferences';
|
|
42
|
+
LSP_CALL_HIERARCHY: 'lspCallHierarchy';
|
|
43
|
+
}
|
|
44
|
+
interface CompleteMetadata {
|
|
45
|
+
instructions: string;
|
|
46
|
+
prompts: Record<string, PromptMetadata>;
|
|
47
|
+
toolNames: ToolNames;
|
|
48
|
+
baseSchema: {
|
|
49
|
+
mainResearchGoal: string;
|
|
50
|
+
researchGoal: string;
|
|
51
|
+
reasoning: string;
|
|
52
|
+
bulkQuery: (toolName: string) => string;
|
|
53
|
+
};
|
|
54
|
+
tools: Record<string, ToolMetadata>;
|
|
55
|
+
baseHints: {
|
|
56
|
+
hasResults: readonly string[];
|
|
57
|
+
empty: readonly string[];
|
|
58
|
+
};
|
|
59
|
+
genericErrorHints: readonly string[];
|
|
60
|
+
bulkOperations?: {
|
|
61
|
+
instructions?: {
|
|
62
|
+
base?: string;
|
|
63
|
+
hasResults?: string;
|
|
64
|
+
empty?: string;
|
|
65
|
+
error?: string;
|
|
66
|
+
};
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
//#endregion
|
|
70
|
+
//#region src/index.d.ts
|
|
71
|
+
declare function registerAllTools(server: McpServer, _content: CompleteMetadata): Promise<void>;
|
|
72
|
+
//#endregion
|
|
73
|
+
export { registerAllTools };
|
|
74
|
+
//# sourceMappingURL=index.d.ts.map
|