@ldraney/github-mcp 0.1.0 → 0.2.0-beta.1

package/dist/tools/categories/checks.js

@@ -0,0 +1,554 @@
+import { successResult } from '../types.js';
+export const checksCategory = {
+    name: 'checks',
+    description: 'GitHub checks tools',
+    tools: [
+        // list_for_ref - List check runs for a Git reference
+        {
+            definition: {
+                name: 'github_checks_list_for_ref',
+                description: 'List check runs for a commit ref (branch name, tag, or SHA)',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        ref: {
+                            type: 'string',
+                            description: 'The commit reference (branch name, tag, or SHA)',
+                        },
+                        check_name: {
+                            type: 'string',
+                            description: 'Filter by check run name',
+                        },
+                        status: {
+                            type: 'string',
+                            enum: ['queued', 'in_progress', 'completed'],
+                            description: 'Filter by check run status',
+                        },
+                        filter: {
+                            type: 'string',
+                            enum: ['latest', 'all'],
+                            description: 'Filter check runs (latest per check name or all)',
+                        },
+                        per_page: {
+                            type: 'number',
+                            description: 'Results per page (max 100)',
+                        },
+                        page: {
+                            type: 'number',
+                            description: 'Page number',
+                        },
+                    },
+                    required: ['owner', 'repo', 'ref'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.listForRef({
+                    owner: args.owner,
+                    repo: args.repo,
+                    ref: args.ref,
+                    check_name: args.check_name,
+                    status: args.status,
+                    filter: args.filter,
+                    per_page: args.per_page,
+                    page: args.page,
+                });
+                return successResult(data);
+            },
+        },
+        // list_for_suite - List check runs in a check suite
+        {
+            definition: {
+                name: 'github_checks_list_for_suite',
+                description: 'List check runs in a check suite',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        check_suite_id: {
+                            type: 'number',
+                            description: 'The unique identifier of the check suite',
+                        },
+                        check_name: {
+                            type: 'string',
+                            description: 'Filter by check run name',
+                        },
+                        status: {
+                            type: 'string',
+                            enum: ['queued', 'in_progress', 'completed'],
+                            description: 'Filter by check run status',
+                        },
+                        filter: {
+                            type: 'string',
+                            enum: ['latest', 'all'],
+                            description: 'Filter check runs (latest per check name or all)',
+                        },
+                        per_page: {
+                            type: 'number',
+                            description: 'Results per page (max 100)',
+                        },
+                        page: {
+                            type: 'number',
+                            description: 'Page number',
+                        },
+                    },
+                    required: ['owner', 'repo', 'check_suite_id'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.listForSuite({
+                    owner: args.owner,
+                    repo: args.repo,
+                    check_suite_id: args.check_suite_id,
+                    check_name: args.check_name,
+                    status: args.status,
+                    filter: args.filter,
+                    per_page: args.per_page,
+                    page: args.page,
+                });
+                return successResult(data);
+            },
+        },
+        // get - Get a check run
+        {
+            definition: {
+                name: 'github_checks_get',
+                description: 'Get a specific check run by ID',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        check_run_id: {
+                            type: 'number',
+                            description: 'The unique identifier of the check run',
+                        },
+                    },
+                    required: ['owner', 'repo', 'check_run_id'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.get({
+                    owner: args.owner,
+                    repo: args.repo,
+                    check_run_id: args.check_run_id,
+                });
+                return successResult(data);
+            },
+        },
+        // create - Create a check run
+        {
+            definition: {
+                name: 'github_checks_create',
+                description: 'Create a new check run for a specific commit SHA. Requires GitHub App authentication.',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        name: {
+                            type: 'string',
+                            description: 'The name of the check run',
+                        },
+                        head_sha: {
+                            type: 'string',
+                            description: 'The SHA of the commit to associate with this check run',
+                        },
+                        details_url: {
+                            type: 'string',
+                            description: 'URL with full details of the check run',
+                        },
+                        external_id: {
+                            type: 'string',
+                            description: 'A reference for the run on the integrator system',
+                        },
+                        status: {
+                            type: 'string',
+                            enum: ['queued', 'in_progress', 'completed'],
+                            description: 'The current status of the check run',
+                        },
+                        started_at: {
+                            type: 'string',
+                            description: 'ISO 8601 timestamp when the check run started',
+                        },
+                        conclusion: {
+                            type: 'string',
+                            enum: ['action_required', 'cancelled', 'failure', 'neutral', 'success', 'skipped', 'stale', 'timed_out'],
+                            description: 'The final conclusion of the check (required if status is completed)',
+                        },
+                        completed_at: {
+                            type: 'string',
+                            description: 'ISO 8601 timestamp when the check run completed',
+                        },
+                        output_title: {
+                            type: 'string',
+                            description: 'Title of the check run output',
+                        },
+                        output_summary: {
+                            type: 'string',
+                            description: 'Summary of the check run output (supports Markdown)',
+                        },
+                        output_text: {
+                            type: 'string',
+                            description: 'Details of the check run output (supports Markdown)',
+                        },
+                    },
+                    required: ['owner', 'repo', 'name', 'head_sha'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const params = {
+                    owner: args.owner,
+                    repo: args.repo,
+                    name: args.name,
+                    head_sha: args.head_sha,
+                };
+                if (args.details_url)
+                    params.details_url = args.details_url;
+                if (args.external_id)
+                    params.external_id = args.external_id;
+                if (args.status)
+                    params.status = args.status;
+                if (args.started_at)
+                    params.started_at = args.started_at;
+                if (args.conclusion)
+                    params.conclusion = args.conclusion;
+                if (args.completed_at)
+                    params.completed_at = args.completed_at;
+                // Build output object if any output fields are provided
+                if (args.output_title || args.output_summary) {
+                    const output = {
+                        title: args.output_title,
+                        summary: args.output_summary,
+                    };
+                    if (args.output_text)
+                        output.text = args.output_text;
+                    params.output = output;
+                }
+                const { data } = await octokit.checks.create(params);
+                return successResult(data);
+            },
+        },
+        // update - Update a check run
+        {
+            definition: {
+                name: 'github_checks_update',
+                description: 'Update an existing check run. Requires GitHub App authentication.',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        check_run_id: {
+                            type: 'number',
+                            description: 'The unique identifier of the check run',
+                        },
+                        name: {
+                            type: 'string',
+                            description: 'The name of the check run',
+                        },
+                        details_url: {
+                            type: 'string',
+                            description: 'URL with full details of the check run',
+                        },
+                        external_id: {
+                            type: 'string',
+                            description: 'A reference for the run on the integrator system',
+                        },
+                        status: {
+                            type: 'string',
+                            enum: ['queued', 'in_progress', 'completed'],
+                            description: 'The current status of the check run',
+                        },
+                        started_at: {
+                            type: 'string',
+                            description: 'ISO 8601 timestamp when the check run started',
+                        },
+                        conclusion: {
+                            type: 'string',
+                            enum: ['action_required', 'cancelled', 'failure', 'neutral', 'success', 'skipped', 'stale', 'timed_out'],
+                            description: 'The final conclusion of the check (required if status is completed)',
+                        },
+                        completed_at: {
+                            type: 'string',
+                            description: 'ISO 8601 timestamp when the check run completed',
+                        },
+                        output_title: {
+                            type: 'string',
+                            description: 'Title of the check run output',
+                        },
+                        output_summary: {
+                            type: 'string',
+                            description: 'Summary of the check run output (supports Markdown)',
+                        },
+                        output_text: {
+                            type: 'string',
+                            description: 'Details of the check run output (supports Markdown)',
+                        },
+                    },
+                    required: ['owner', 'repo', 'check_run_id'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const params = {
+                    owner: args.owner,
+                    repo: args.repo,
+                    check_run_id: args.check_run_id,
+                };
+                if (args.name)
+                    params.name = args.name;
+                if (args.details_url)
+                    params.details_url = args.details_url;
+                if (args.external_id)
+                    params.external_id = args.external_id;
+                if (args.status)
+                    params.status = args.status;
+                if (args.started_at)
+                    params.started_at = args.started_at;
+                if (args.conclusion)
+                    params.conclusion = args.conclusion;
+                if (args.completed_at)
+                    params.completed_at = args.completed_at;
+                // Build output object if any output fields are provided
+                if (args.output_title || args.output_summary) {
+                    const output = {
+                        title: args.output_title,
+                        summary: args.output_summary,
+                    };
+                    if (args.output_text)
+                        output.text = args.output_text;
+                    params.output = output;
+                }
+                const { data } = await octokit.checks.update(params);
+                return successResult(data);
+            },
+        },
+        // list_suites_for_ref - List check suites for a Git reference
+        {
+            definition: {
+                name: 'github_checks_list_suites_for_ref',
+                description: 'List check suites for a commit ref (branch name, tag, or SHA)',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        ref: {
+                            type: 'string',
+                            description: 'The commit reference (branch name, tag, or SHA)',
+                        },
+                        app_id: {
+                            type: 'number',
+                            description: 'Filter by GitHub App ID',
+                        },
+                        check_name: {
+                            type: 'string',
+                            description: 'Filter by check name',
+                        },
+                        per_page: {
+                            type: 'number',
+                            description: 'Results per page (max 100)',
+                        },
+                        page: {
+                            type: 'number',
+                            description: 'Page number',
+                        },
+                    },
+                    required: ['owner', 'repo', 'ref'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.listSuitesForRef({
+                    owner: args.owner,
+                    repo: args.repo,
+                    ref: args.ref,
+                    app_id: args.app_id,
+                    check_name: args.check_name,
+                    per_page: args.per_page,
+                    page: args.page,
+                });
+                return successResult(data);
+            },
+        },
+        // get_suite - Get a check suite
+        {
+            definition: {
+                name: 'github_checks_get_suite',
+                description: 'Get a specific check suite by ID',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        check_suite_id: {
+                            type: 'number',
+                            description: 'The unique identifier of the check suite',
+                        },
+                    },
+                    required: ['owner', 'repo', 'check_suite_id'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.getSuite({
+                    owner: args.owner,
+                    repo: args.repo,
+                    check_suite_id: args.check_suite_id,
+                });
+                return successResult(data);
+            },
+        },
+        // create_suite - Create a check suite
+        {
+            definition: {
+                name: 'github_checks_create_suite',
+                description: 'Manually create a check suite for a commit. Requires GitHub App authentication.',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        head_sha: {
+                            type: 'string',
+                            description: 'The SHA of the commit to associate with this check suite',
+                        },
+                    },
+                    required: ['owner', 'repo', 'head_sha'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.createSuite({
+                    owner: args.owner,
+                    repo: args.repo,
+                    head_sha: args.head_sha,
+                });
+                return successResult(data);
+            },
+        },
+        // rerequest_suite - Rerequest a check suite
+        {
+            definition: {
+                name: 'github_checks_rerequest_suite',
+                description: 'Trigger a rerequest of a check suite. Causes GitHub to re-send the check_suite webhook event.',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        check_suite_id: {
+                            type: 'number',
+                            description: 'The unique identifier of the check suite',
+                        },
+                    },
+                    required: ['owner', 'repo', 'check_suite_id'],
+                },
+            },
+            handler: async (octokit, args) => {
+                await octokit.checks.rerequestSuite({
+                    owner: args.owner,
+                    repo: args.repo,
+                    check_suite_id: args.check_suite_id,
+                });
+                return successResult({ success: true, message: 'Check suite rerequest triggered' });
+            },
+        },
+        // list_annotations - List check run annotations
+        {
+            definition: {
+                name: 'github_checks_list_annotations',
+                description: 'List annotations for a check run (issues, warnings, or notices)',
+                inputSchema: {
+                    type: 'object',
+                    properties: {
+                        owner: {
+                            type: 'string',
+                            description: 'Repository owner',
+                        },
+                        repo: {
+                            type: 'string',
+                            description: 'Repository name',
+                        },
+                        check_run_id: {
+                            type: 'number',
+                            description: 'The unique identifier of the check run',
+                        },
+                        per_page: {
+                            type: 'number',
+                            description: 'Results per page (max 100)',
+                        },
+                        page: {
+                            type: 'number',
+                            description: 'Page number',
+                        },
+                    },
+                    required: ['owner', 'repo', 'check_run_id'],
+                },
+            },
+            handler: async (octokit, args) => {
+                const { data } = await octokit.checks.listAnnotations({
+                    owner: args.owner,
+                    repo: args.repo,
+                    check_run_id: args.check_run_id,
+                    per_page: args.per_page,
+                    page: args.page,
+                });
+                return successResult(data);
+            },
+        },
+    ],
+};

package/dist/tools/categories/codeScanning.d.ts

@@ -0,0 +1,2 @@
+import type { ToolCategory } from '../types.js';
+export declare const codeScanningCategory: ToolCategory;