Skip to content

Commit cc069a7

Browse files
Merge branch 'main' into open-ai-aye-aye
2 parents 1cde26d + c7c0ee6 commit cc069a7

File tree

3 files changed

+97
-185
lines changed

3 files changed

+97
-185
lines changed

README.md

Lines changed: 55 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -590,108 +590,53 @@ The following sets of tools are available:
590590

591591
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/workflow-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/workflow-light.png"><img src="pkg/octicons/icons/workflow-light.png" width="20" height="20" alt="workflow"></picture> Actions</summary>
592592

593-
- **cancel_workflow_run** - Cancel workflow run
593+
- **actions_get** - Get details of GitHub Actions resources (workflows, workflow runs, jobs, and artifacts)
594594
- **Required OAuth Scopes**: `repo`
595+
- `method`: The method to execute (string, required)
595596
- `owner`: Repository owner (string, required)
596597
- `repo`: Repository name (string, required)
597-
- `run_id`: The unique identifier of the workflow run (number, required)
598+
- `resource_id`: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:
599+
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' method.
600+
- Provide a workflow run ID for 'get_workflow_run', 'get_workflow_run_usage', and 'get_workflow_run_logs_url' methods.
601+
- Provide an artifact ID for 'download_workflow_run_artifact' method.
602+
- Provide a job ID for 'get_workflow_job' method.
603+
(string, required)
598604

599-
- **delete_workflow_run_logs** - Delete workflow logs
605+
- **actions_list** - List GitHub Actions workflows in a repository
600606
- **Required OAuth Scopes**: `repo`
607+
- `method`: The action to perform (string, required)
601608
- `owner`: Repository owner (string, required)
609+
- `page`: Page number for pagination (default: 1) (number, optional)
610+
- `per_page`: Results per page for pagination (default: 30, max: 100) (number, optional)
602611
- `repo`: Repository name (string, required)
603-
- `run_id`: The unique identifier of the workflow run (number, required)
604-
605-
- **download_workflow_run_artifact** - Download workflow artifact
612+
- `resource_id`: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:
613+
- Do not provide any resource ID for 'list_workflows' method.
614+
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'list_workflow_runs' method, or omit to list all workflow runs in the repository.
615+
- Provide a workflow run ID for 'list_workflow_jobs' and 'list_workflow_run_artifacts' methods.
616+
(string, optional)
617+
- `workflow_jobs_filter`: Filters for workflow jobs. **ONLY** used when method is 'list_workflow_jobs' (object, optional)
618+
- `workflow_runs_filter`: Filters for workflow runs. **ONLY** used when method is 'list_workflow_runs' (object, optional)
619+
620+
- **actions_run_trigger** - Trigger GitHub Actions workflow actions
606621
- **Required OAuth Scopes**: `repo`
607-
- `artifact_id`: The unique identifier of the artifact (number, required)
622+
- `inputs`: Inputs the workflow accepts. Only used for 'run_workflow' method. (object, optional)
623+
- `method`: The method to execute (string, required)
608624
- `owner`: Repository owner (string, required)
625+
- `ref`: The git reference for the workflow. The reference can be a branch or tag name. Required for 'run_workflow' method. (string, optional)
609626
- `repo`: Repository name (string, required)
627+
- `run_id`: The ID of the workflow run. Required for all methods except 'run_workflow'. (number, optional)
628+
- `workflow_id`: The workflow ID (numeric) or workflow file name (e.g., main.yml, ci.yaml). Required for 'run_workflow' method. (string, optional)
610629

611-
- **get_job_logs** - Get job logs
630+
- **get_job_logs** - Get GitHub Actions workflow job logs
612631
- **Required OAuth Scopes**: `repo`
613-
- `failed_only`: When true, gets logs for all failed jobs in run_id (boolean, optional)
614-
- `job_id`: The unique identifier of the workflow job (required for single job logs) (number, optional)
632+
- `failed_only`: When true, gets logs for all failed jobs in the workflow run specified by run_id. Requires run_id to be provided. (boolean, optional)
633+
- `job_id`: The unique identifier of the workflow job. Required when getting logs for a single job. (number, optional)
615634
- `owner`: Repository owner (string, required)
616635
- `repo`: Repository name (string, required)
617636
- `return_content`: Returns actual log content instead of URLs (boolean, optional)
618-
- `run_id`: Workflow run ID (required when using failed_only) (number, optional)
637+
- `run_id`: The unique identifier of the workflow run. Required when failed_only is true to get logs for all failed jobs in the run. (number, optional)
619638
- `tail_lines`: Number of lines to return from the end of the log (number, optional)
620639

621-
- **get_workflow_run** - Get workflow run
622-
- **Required OAuth Scopes**: `repo`
623-
- `owner`: Repository owner (string, required)
624-
- `repo`: Repository name (string, required)
625-
- `run_id`: The unique identifier of the workflow run (number, required)
626-
627-
- **get_workflow_run_logs** - Get workflow run logs
628-
- **Required OAuth Scopes**: `repo`
629-
- `owner`: Repository owner (string, required)
630-
- `repo`: Repository name (string, required)
631-
- `run_id`: The unique identifier of the workflow run (number, required)
632-
633-
- **get_workflow_run_usage** - Get workflow usage
634-
- **Required OAuth Scopes**: `repo`
635-
- `owner`: Repository owner (string, required)
636-
- `repo`: Repository name (string, required)
637-
- `run_id`: The unique identifier of the workflow run (number, required)
638-
639-
- **list_workflow_jobs** - List workflow jobs
640-
- **Required OAuth Scopes**: `repo`
641-
- `filter`: Filters jobs by their completed_at timestamp (string, optional)
642-
- `owner`: Repository owner (string, required)
643-
- `page`: Page number for pagination (min 1) (number, optional)
644-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
645-
- `repo`: Repository name (string, required)
646-
- `run_id`: The unique identifier of the workflow run (number, required)
647-
648-
- **list_workflow_run_artifacts** - List workflow artifacts
649-
- **Required OAuth Scopes**: `repo`
650-
- `owner`: Repository owner (string, required)
651-
- `page`: Page number for pagination (min 1) (number, optional)
652-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
653-
- `repo`: Repository name (string, required)
654-
- `run_id`: The unique identifier of the workflow run (number, required)
655-
656-
- **list_workflow_runs** - List workflow runs
657-
- **Required OAuth Scopes**: `repo`
658-
- `actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional)
659-
- `branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional)
660-
- `event`: Returns workflow runs for a specific event type (string, optional)
661-
- `owner`: Repository owner (string, required)
662-
- `page`: Page number for pagination (min 1) (number, optional)
663-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
664-
- `repo`: Repository name (string, required)
665-
- `status`: Returns workflow runs with the check run status (string, optional)
666-
- `workflow_id`: The workflow ID or workflow file name (string, required)
667-
668-
- **list_workflows** - List workflows
669-
- **Required OAuth Scopes**: `repo`
670-
- `owner`: Repository owner (string, required)
671-
- `page`: Page number for pagination (min 1) (number, optional)
672-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
673-
- `repo`: Repository name (string, required)
674-
675-
- **rerun_failed_jobs** - Rerun failed jobs
676-
- **Required OAuth Scopes**: `repo`
677-
- `owner`: Repository owner (string, required)
678-
- `repo`: Repository name (string, required)
679-
- `run_id`: The unique identifier of the workflow run (number, required)
680-
681-
- **rerun_workflow_run** - Rerun workflow run
682-
- **Required OAuth Scopes**: `repo`
683-
- `owner`: Repository owner (string, required)
684-
- `repo`: Repository name (string, required)
685-
- `run_id`: The unique identifier of the workflow run (number, required)
686-
687-
- **run_workflow** - Run workflow
688-
- **Required OAuth Scopes**: `repo`
689-
- `inputs`: Inputs the workflow accepts (object, optional)
690-
- `owner`: Repository owner (string, required)
691-
- `ref`: The git reference for the workflow. The reference can be a branch or tag name. (string, required)
692-
- `repo`: Repository name (string, required)
693-
- `workflow_id`: The workflow ID (numeric) or workflow file name (e.g., main.yml, ci.yaml) (string, required)
694-
695640
</details>
696641

697642
<details>
@@ -1029,84 +974,43 @@ The following sets of tools are available:
1029974

1030975
<summary><picture><source media="(prefers-color-scheme: dark)" srcset="pkg/octicons/icons/project-dark.png"><source media="(prefers-color-scheme: light)" srcset="pkg/octicons/icons/project-light.png"><img src="pkg/octicons/icons/project-light.png" width="20" height="20" alt="project"></picture> Projects</summary>
1031976

1032-
- **add_project_item** - Add project item
1033-
- **Required OAuth Scopes**: `project`
1034-
- `item_id`: The numeric ID of the issue or pull request to add to the project. (number, required)
1035-
- `item_type`: The item's type, either issue or pull_request. (string, required)
1036-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1037-
- `owner_type`: Owner type (string, required)
1038-
- `project_number`: The project's number. (number, required)
1039-
1040-
- **delete_project_item** - Delete project item
1041-
- **Required OAuth Scopes**: `project`
1042-
- `item_id`: The internal project item ID to delete from the project (not the issue or pull request ID). (number, required)
1043-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1044-
- `owner_type`: Owner type (string, required)
1045-
- `project_number`: The project's number. (number, required)
1046-
1047-
- **get_project** - Get project
1048-
- **Required OAuth Scopes**: `read:project`
1049-
- **Accepted OAuth Scopes**: `project`, `read:project`
1050-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1051-
- `owner_type`: Owner type (string, required)
1052-
- `project_number`: The project's number (number, required)
1053-
1054-
- **get_project_field** - Get project field
1055-
- **Required OAuth Scopes**: `read:project`
1056-
- **Accepted OAuth Scopes**: `project`, `read:project`
1057-
- `field_id`: The field's id. (number, required)
1058-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1059-
- `owner_type`: Owner type (string, required)
1060-
- `project_number`: The project's number. (number, required)
1061-
1062-
- **get_project_item** - Get project item
977+
- **projects_get** - Get details of GitHub Projects resources
1063978
- **Required OAuth Scopes**: `read:project`
1064979
- **Accepted OAuth Scopes**: `project`, `read:project`
1065-
- `fields`: Specific list of field IDs to include in the response (e.g. ["102589", "985201", "169875"]). If not provided, only the title field is included. (string[], optional)
1066-
- `item_id`: The item's ID. (number, required)
1067-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1068-
- `owner_type`: Owner type (string, required)
1069-
- `project_number`: The project's number. (number, required)
1070-
1071-
- **list_project_fields** - List project fields
1072-
- **Required OAuth Scopes**: `read:project`
1073-
- **Accepted OAuth Scopes**: `project`, `read:project`
1074-
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1075-
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
1076-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1077-
- `owner_type`: Owner type (string, required)
1078-
- `per_page`: Results per page (max 50) (number, optional)
1079-
- `project_number`: The project's number. (number, required)
1080-
1081-
- **list_project_items** - List project items
1082-
- **Required OAuth Scopes**: `read:project`
1083-
- **Accepted OAuth Scopes**: `project`, `read:project`
1084-
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1085-
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
1086-
- `fields`: Field IDs to include (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this, only titles returned. (string[], optional)
1087-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1088-
- `owner_type`: Owner type (string, required)
1089-
- `per_page`: Results per page (max 50) (number, optional)
980+
- `field_id`: The field's ID. Required for 'get_project_field' method. (number, optional)
981+
- `fields`: Specific list of field IDs to include in the response when getting a project item (e.g. ["102589", "985201", "169875"]). If not provided, only the title field is included. Only used for 'get_project_item' method. (string[], optional)
982+
- `item_id`: The item's ID. Required for 'get_project_item' method. (number, optional)
983+
- `method`: The method to execute (string, required)
984+
- `owner`: The owner (user or organization login). The name is not case sensitive. (string, required)
985+
- `owner_type`: Owner type (user or org). If not provided, will be automatically detected. (string, optional)
1090986
- `project_number`: The project's number. (number, required)
1091-
- `query`: Query string for advanced filtering of project items using GitHub's project filtering syntax. (string, optional)
1092987

1093-
- **list_projects** - List projects
988+
- **projects_list** - List GitHub Projects resources
1094989
- **Required OAuth Scopes**: `read:project`
1095990
- **Accepted OAuth Scopes**: `project`, `read:project`
1096991
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1097992
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
1098-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1099-
- `owner_type`: Owner type (string, required)
993+
- `fields`: Field IDs to include when listing project items (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this, only titles returned. Only used for 'list_project_items' method. (string[], optional)
994+
- `method`: The action to perform (string, required)
995+
- `owner`: The owner (user or organization login). The name is not case sensitive. (string, required)
996+
- `owner_type`: Owner type (user or org). If not provided, will automatically try both. (string, optional)
1100997
- `per_page`: Results per page (max 50) (number, optional)
1101-
- `query`: Filter projects by title text and open/closed state; permitted qualifiers: is:open, is:closed; examples: "roadmap is:open", "is:open feature planning". (string, optional)
998+
- `project_number`: The project's number. Required for 'list_project_fields' and 'list_project_items' methods. (number, optional)
999+
- `query`: Filter/query string. For list_projects: filter by title text and state (e.g. "roadmap is:open"). For list_project_items: advanced filtering using GitHub's project filtering syntax. (string, optional)
11021000

1103-
- **update_project_item** - Update project item
1001+
- **projects_write** - Modify GitHub Project items
11041002
- **Required OAuth Scopes**: `project`
1105-
- `item_id`: The unique identifier of the project item. This is not the issue or pull request ID. (number, required)
1106-
- `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == org it is the name of the organization. The name is not case sensitive. (string, required)
1107-
- `owner_type`: Owner type (string, required)
1003+
- `issue_number`: The issue number (use when item_type is 'issue' for 'add_project_item' method). Provide either issue_number or pull_request_number. (number, optional)
1004+
- `item_id`: The project item ID. Required for 'update_project_item' and 'delete_project_item' methods. (number, optional)
1005+
- `item_owner`: The owner (user or organization) of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)
1006+
- `item_repo`: The name of the repository containing the issue or pull request. Required for 'add_project_item' method. (string, optional)
1007+
- `item_type`: The item's type, either issue or pull_request. Required for 'add_project_item' method. (string, optional)
1008+
- `method`: The method to execute (string, required)
1009+
- `owner`: The project owner (user or organization login). The name is not case sensitive. (string, required)
1010+
- `owner_type`: Owner type (user or org). If not provided, will be automatically detected. (string, optional)
11081011
- `project_number`: The project's number. (number, required)
1109-
- `updated_field`: Object consisting of the ID of the project field to update and the new value for the field. To clear the field, set value to null. Example: {"id": 123456, "value": "New Value"} (object, required)
1012+
- `pull_request_number`: The pull request number (use when item_type is 'pull_request' for 'add_project_item' method). Provide either issue_number or pull_request_number. (number, optional)
1013+
- `updated_field`: Object consisting of the ID of the project field to update and the new value for the field. To clear the field, set value to null. Example: {"id": 123456, "value": "New Value"}. Required for 'update_project_item' method. (object, optional)
11101014

11111015
</details>
11121016

0 commit comments

Comments
 (0)