Skip to content

Commit 42cad66

Browse files
committed
update docs and toolsnaps
1 parent 7028be0 commit 42cad66

File tree

2 files changed

+26
-60
lines changed

2 files changed

+26
-60
lines changed

README.md

Lines changed: 26 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -428,20 +428,40 @@ The following sets of tools are available:
428428

429429
<summary>Actions</summary>
430430

431-
- **cancel_workflow_run** - Cancel workflow run
431+
- **actions_get** - Get details of GitHub Actions resources (workflows, workflow runs, jobs, and artifacts)
432+
- `action`: The action to perform (string, required)
432433
- `owner`: Repository owner (string, required)
433434
- `repo`: Repository name (string, required)
434-
- `run_id`: The unique identifier of the workflow run (number, required)
435+
- `resource_id`: The unique identifier of the resource. This will vary based on the "action" provided, so ensure you provide the correct ID:
436+
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' action.
437+
- Provide a workflow run ID for 'get_workflow_run', 'download_workflow_run_artifact' and 'get_workflow_run_usage' actions.
438+
- Provide a job ID for the 'get_workflow_job' action.
439+
(string, required)
435440

436-
- **delete_workflow_run_logs** - Delete workflow logs
441+
- **actions_list** - List GitHub Actions workflows in a repository
442+
- `action`: The action to perform (string, required)
437443
- `owner`: Repository owner (string, required)
444+
- `page`: Page number for pagination (min 1) (number, optional)
445+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
438446
- `repo`: Repository name (string, required)
439-
- `run_id`: The unique identifier of the workflow run (number, required)
447+
- `resource_id`: The unique identifier of the resource. This will vary based on the "action" provided, so ensure you provide the correct ID:
448+
- Do not provide any resource ID for 'list_workflows' action.
449+
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'list_workflow_runs' actions.
450+
- Provide a workflow run ID for 'list_workflow_jobs' and 'list_workflow_run_artifacts' actions.
451+
(string, optional)
452+
- `workflow_jobs_filter`: Filters for workflow jobs. **ONLY** used when action is 'list_workflow_jobs' (object, optional)
453+
- `workflow_runs_filter`: Filters for workflow runs. **ONLY** used when action is 'list_workflow_runs' (object, optional)
454+
455+
- **actions_run_trigger** - Trigger GitHub Actions workflow actions for a specific workflow run.
456+
- `action`: The action to trigger (string, required)
457+
- `owner`: Repository owner (string, required)
458+
- `repo`: Repository name (string, required)
459+
- `run_id`: The ID of the workflow run to trigger (number, required)
440460

441-
- **download_workflow_run_artifact** - Download workflow artifact
442-
- `artifact_id`: The unique identifier of the artifact (number, required)
461+
- **delete_workflow_run_logs** - Delete workflow logs
443462
- `owner`: Repository owner (string, required)
444463
- `repo`: Repository name (string, required)
464+
- `run_id`: The unique identifier of the workflow run (number, required)
445465

446466
- **get_job_logs** - Get job logs
447467
- `failed_only`: When true, gets logs for all failed jobs in run_id (boolean, optional)
@@ -452,63 +472,11 @@ The following sets of tools are available:
452472
- `run_id`: Workflow run ID (required when using failed_only) (number, optional)
453473
- `tail_lines`: Number of lines to return from the end of the log (number, optional)
454474

455-
- **get_workflow_run** - Get workflow run
456-
- `owner`: Repository owner (string, required)
457-
- `repo`: Repository name (string, required)
458-
- `run_id`: The unique identifier of the workflow run (number, required)
459-
460475
- **get_workflow_run_logs** - Get workflow run logs
461476
- `owner`: Repository owner (string, required)
462477
- `repo`: Repository name (string, required)
463478
- `run_id`: The unique identifier of the workflow run (number, required)
464479

465-
- **get_workflow_run_usage** - Get workflow usage
466-
- `owner`: Repository owner (string, required)
467-
- `repo`: Repository name (string, required)
468-
- `run_id`: The unique identifier of the workflow run (number, required)
469-
470-
- **list_workflow_jobs** - List workflow jobs
471-
- `filter`: Filters jobs by their completed_at timestamp (string, optional)
472-
- `owner`: Repository owner (string, required)
473-
- `page`: Page number for pagination (min 1) (number, optional)
474-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
475-
- `repo`: Repository name (string, required)
476-
- `run_id`: The unique identifier of the workflow run (number, required)
477-
478-
- **list_workflow_run_artifacts** - List workflow artifacts
479-
- `owner`: Repository owner (string, required)
480-
- `page`: Page number for pagination (min 1) (number, optional)
481-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
482-
- `repo`: Repository name (string, required)
483-
- `run_id`: The unique identifier of the workflow run (number, required)
484-
485-
- **list_workflow_runs** - List workflow runs
486-
- `actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional)
487-
- `branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional)
488-
- `event`: Returns workflow runs for a specific event type (string, optional)
489-
- `owner`: Repository owner (string, required)
490-
- `page`: Page number for pagination (min 1) (number, optional)
491-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
492-
- `repo`: Repository name (string, required)
493-
- `status`: Returns workflow runs with the check run status (string, optional)
494-
- `workflow_id`: The workflow ID or workflow file name (string, required)
495-
496-
- **list_workflows** - List workflows
497-
- `owner`: Repository owner (string, required)
498-
- `page`: Page number for pagination (min 1) (number, optional)
499-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
500-
- `repo`: Repository name (string, required)
501-
502-
- **rerun_failed_jobs** - Rerun failed jobs
503-
- `owner`: Repository owner (string, required)
504-
- `repo`: Repository name (string, required)
505-
- `run_id`: The unique identifier of the workflow run (number, required)
506-
507-
- **rerun_workflow_run** - Rerun workflow run
508-
- `owner`: Repository owner (string, required)
509-
- `repo`: Repository name (string, required)
510-
- `run_id`: The unique identifier of the workflow run (number, required)
511-
512480
- **run_workflow** - Run workflow
513481
- `inputs`: Inputs the workflow accepts (object, optional)
514482
- `owner`: Repository owner (string, required)

docs/remote-server.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ Below is a table of available toolsets for the remote GitHub MCP Server. Each to
2222
| all | All available GitHub MCP tools | https://api.githubcopilot.com/mcp/ | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D) | [read-only](https://api.githubcopilot.com/mcp/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=github&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Freadonly%22%7D) |
2323
| Actions | GitHub Actions workflows and CI/CD operations | https://api.githubcopilot.com/mcp/x/actions | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-actions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Factions%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/actions/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-actions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Factions%2Freadonly%22%7D) |
2424
| Code Security | Code security related tools, such as GitHub Code Scanning | https://api.githubcopilot.com/mcp/x/code_security | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-code_security&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcode_security%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/code_security/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-code_security&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcode_security%2Freadonly%22%7D) |
25-
| Copilot | Copilot related tools | https://api.githubcopilot.com/mcp/x/copilot | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-copilot_spaces&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcopilot_spaces%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/copilot_spaces/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-code_security&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcopilot_spaces%2Freadonly%22%7D) |
26-
| Copilot Spaces | Copilot Spaces tools | https://api.githubcopilot.com/mcp/x/copilot_spaces | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-copilot&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcopilot_spaces%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/copilot_spaces/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-copilot&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcopilot%2Freadonly%22%7D) |
2725
| Dependabot | Dependabot tools | https://api.githubcopilot.com/mcp/x/dependabot | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-dependabot&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fdependabot%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/dependabot/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-dependabot&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fdependabot%2Freadonly%22%7D) |
2826
| Discussions | GitHub Discussions related tools | https://api.githubcopilot.com/mcp/x/discussions | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-discussions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fdiscussions%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/discussions/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-discussions&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fdiscussions%2Freadonly%22%7D) |
2927
| Experiments | Experimental features that are not considered stable yet | https://api.githubcopilot.com/mcp/x/experiments | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-experiments&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fexperiments%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/experiments/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-experiments&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fexperiments%2Freadonly%22%7D) |

0 commit comments

Comments
 (0)