Skip to content

Commit 4f60af5

Browse files
committed
update docs
1 parent 55d017e commit 4f60af5

File tree

1 file changed

+45
-145
lines changed

1 file changed

+45
-145
lines changed

README.md

Lines changed: 45 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -522,108 +522,53 @@ The following sets of tools are available:
522522

523523
<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>
524524

525-
- **cancel_workflow_run** - Cancel workflow run
525+
- **actions_get** - Get details of GitHub Actions resources (workflows, workflow runs, jobs, and artifacts)
526526
- **Required OAuth Scopes**: `repo`
527+
- `method`: The method to execute (string, required)
527528
- `owner`: Repository owner (string, required)
528529
- `repo`: Repository name (string, required)
529-
- `run_id`: The unique identifier of the workflow run (number, required)
530+
- `resource_id`: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:
531+
- Provide a workflow ID or workflow file name (e.g. ci.yaml) for 'get_workflow' method.
532+
- Provide a workflow run ID for 'get_workflow_run', 'get_workflow_run_usage', and 'get_workflow_run_logs_url' methods.
533+
- Provide an artifact ID for 'download_workflow_run_artifact' method.
534+
- Provide a job ID for 'get_workflow_job' method.
535+
(string, required)
530536

531-
- **delete_workflow_run_logs** - Delete workflow logs
537+
- **actions_list** - List GitHub Actions workflows in a repository
532538
- **Required OAuth Scopes**: `repo`
539+
- `method`: The action to perform (string, required)
533540
- `owner`: Repository owner (string, required)
541+
- `page`: Page number for pagination (default: 1) (number, optional)
542+
- `per_page`: Results per page for pagination (default: 30, max: 100) (number, optional)
534543
- `repo`: Repository name (string, required)
535-
- `run_id`: The unique identifier of the workflow run (number, required)
536-
537-
- **download_workflow_run_artifact** - Download workflow artifact
544+
- `resource_id`: The unique identifier of the resource. This will vary based on the "method" provided, so ensure you provide the correct ID:
545+
- Do not provide any resource ID for 'list_workflows' method.
546+
- 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.
547+
- Provide a workflow run ID for 'list_workflow_jobs' and 'list_workflow_run_artifacts' methods.
548+
(string, optional)
549+
- `workflow_jobs_filter`: Filters for workflow jobs. **ONLY** used when method is 'list_workflow_jobs' (object, optional)
550+
- `workflow_runs_filter`: Filters for workflow runs. **ONLY** used when method is 'list_workflow_runs' (object, optional)
551+
552+
- **actions_run_trigger** - Trigger GitHub Actions workflow actions
538553
- **Required OAuth Scopes**: `repo`
539-
- `artifact_id`: The unique identifier of the artifact (number, required)
554+
- `inputs`: Inputs the workflow accepts. Only used for 'run_workflow' method. (object, optional)
555+
- `method`: The method to execute (string, required)
540556
- `owner`: Repository owner (string, required)
557+
- `ref`: The git reference for the workflow. The reference can be a branch or tag name. Required for 'run_workflow' method. (string, optional)
541558
- `repo`: Repository name (string, required)
559+
- `run_id`: The ID of the workflow run. Required for all methods except 'run_workflow'. (number, optional)
560+
- `workflow_id`: The workflow ID (numeric) or workflow file name (e.g., main.yml, ci.yaml). Required for 'run_workflow' method. (string, optional)
542561

543-
- **get_job_logs** - Get job logs
562+
- **get_job_logs** - Get GitHub Actions workflow job logs
544563
- **Required OAuth Scopes**: `repo`
545-
- `failed_only`: When true, gets logs for all failed jobs in run_id (boolean, optional)
546-
- `job_id`: The unique identifier of the workflow job (required for single job logs) (number, optional)
564+
- `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)
565+
- `job_id`: The unique identifier of the workflow job. Required when getting logs for a single job. (number, optional)
547566
- `owner`: Repository owner (string, required)
548567
- `repo`: Repository name (string, required)
549568
- `return_content`: Returns actual log content instead of URLs (boolean, optional)
550-
- `run_id`: Workflow run ID (required when using failed_only) (number, optional)
569+
- `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)
551570
- `tail_lines`: Number of lines to return from the end of the log (number, optional)
552571

553-
- **get_workflow_run** - Get workflow run
554-
- **Required OAuth Scopes**: `repo`
555-
- `owner`: Repository owner (string, required)
556-
- `repo`: Repository name (string, required)
557-
- `run_id`: The unique identifier of the workflow run (number, required)
558-
559-
- **get_workflow_run_logs** - Get workflow run logs
560-
- **Required OAuth Scopes**: `repo`
561-
- `owner`: Repository owner (string, required)
562-
- `repo`: Repository name (string, required)
563-
- `run_id`: The unique identifier of the workflow run (number, required)
564-
565-
- **get_workflow_run_usage** - Get workflow usage
566-
- **Required OAuth Scopes**: `repo`
567-
- `owner`: Repository owner (string, required)
568-
- `repo`: Repository name (string, required)
569-
- `run_id`: The unique identifier of the workflow run (number, required)
570-
571-
- **list_workflow_jobs** - List workflow jobs
572-
- **Required OAuth Scopes**: `repo`
573-
- `filter`: Filters jobs by their completed_at timestamp (string, optional)
574-
- `owner`: Repository owner (string, required)
575-
- `page`: Page number for pagination (min 1) (number, optional)
576-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
577-
- `repo`: Repository name (string, required)
578-
- `run_id`: The unique identifier of the workflow run (number, required)
579-
580-
- **list_workflow_run_artifacts** - List workflow artifacts
581-
- **Required OAuth Scopes**: `repo`
582-
- `owner`: Repository owner (string, required)
583-
- `page`: Page number for pagination (min 1) (number, optional)
584-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
585-
- `repo`: Repository name (string, required)
586-
- `run_id`: The unique identifier of the workflow run (number, required)
587-
588-
- **list_workflow_runs** - List workflow runs
589-
- **Required OAuth Scopes**: `repo`
590-
- `actor`: Returns someone's workflow runs. Use the login for the user who created the workflow run. (string, optional)
591-
- `branch`: Returns workflow runs associated with a branch. Use the name of the branch. (string, optional)
592-
- `event`: Returns workflow runs for a specific event type (string, optional)
593-
- `owner`: Repository owner (string, required)
594-
- `page`: Page number for pagination (min 1) (number, optional)
595-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
596-
- `repo`: Repository name (string, required)
597-
- `status`: Returns workflow runs with the check run status (string, optional)
598-
- `workflow_id`: The workflow ID or workflow file name (string, required)
599-
600-
- **list_workflows** - List workflows
601-
- **Required OAuth Scopes**: `repo`
602-
- `owner`: Repository owner (string, required)
603-
- `page`: Page number for pagination (min 1) (number, optional)
604-
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
605-
- `repo`: Repository name (string, required)
606-
607-
- **rerun_failed_jobs** - Rerun failed jobs
608-
- **Required OAuth Scopes**: `repo`
609-
- `owner`: Repository owner (string, required)
610-
- `repo`: Repository name (string, required)
611-
- `run_id`: The unique identifier of the workflow run (number, required)
612-
613-
- **rerun_workflow_run** - Rerun workflow run
614-
- **Required OAuth Scopes**: `repo`
615-
- `owner`: Repository owner (string, required)
616-
- `repo`: Repository name (string, required)
617-
- `run_id`: The unique identifier of the workflow run (number, required)
618-
619-
- **run_workflow** - Run workflow
620-
- **Required OAuth Scopes**: `repo`
621-
- `inputs`: Inputs the workflow accepts (object, optional)
622-
- `owner`: Repository owner (string, required)
623-
- `ref`: The git reference for the workflow. The reference can be a branch or tag name. (string, required)
624-
- `repo`: Repository name (string, required)
625-
- `workflow_id`: The workflow ID (numeric) or workflow file name (e.g., main.yml, ci.yaml) (string, required)
626-
627572
</details>
628573

629574
<details>
@@ -961,84 +906,39 @@ The following sets of tools are available:
961906

962907
<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>
963908

964-
- **add_project_item** - Add project item
965-
- **Required OAuth Scopes**: `project`
966-
- `item_id`: The numeric ID of the issue or pull request to add to the project. (number, required)
967-
- `item_type`: The item's type, either issue or pull_request. (string, required)
968-
- `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)
969-
- `owner_type`: Owner type (string, required)
970-
- `project_number`: The project's number. (number, required)
971-
972-
- **delete_project_item** - Delete project item
973-
- **Required OAuth Scopes**: `project`
974-
- `item_id`: The internal project item ID to delete from the project (not the issue or pull request ID). (number, required)
975-
- `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)
976-
- `owner_type`: Owner type (string, required)
977-
- `project_number`: The project's number. (number, required)
978-
979-
- **get_project** - Get project
980-
- **Required OAuth Scopes**: `read:project`
981-
- **Accepted OAuth Scopes**: `project`, `read:project`
982-
- `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)
983-
- `owner_type`: Owner type (string, required)
984-
- `project_number`: The project's number (number, required)
985-
986-
- **get_project_field** - Get project field
987-
- **Required OAuth Scopes**: `read:project`
988-
- **Accepted OAuth Scopes**: `project`, `read:project`
989-
- `field_id`: The field's id. (number, required)
990-
- `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)
991-
- `owner_type`: Owner type (string, required)
992-
- `project_number`: The project's number. (number, required)
993-
994-
- **get_project_item** - Get project item
995-
- **Required OAuth Scopes**: `read:project`
996-
- **Accepted OAuth Scopes**: `project`, `read:project`
997-
- `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)
998-
- `item_id`: The item's ID. (number, required)
999-
- `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)
1000-
- `owner_type`: Owner type (string, required)
1001-
- `project_number`: The project's number. (number, required)
1002-
1003-
- **list_project_fields** - List project fields
1004-
- **Required OAuth Scopes**: `read:project`
1005-
- **Accepted OAuth Scopes**: `project`, `read:project`
1006-
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1007-
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
1008-
- `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)
1009-
- `owner_type`: Owner type (string, required)
1010-
- `per_page`: Results per page (max 50) (number, optional)
1011-
- `project_number`: The project's number. (number, required)
1012-
1013-
- **list_project_items** - List project items
909+
- **projects_get** - Get details of GitHub Projects resources
1014910
- **Required OAuth Scopes**: `read:project`
1015911
- **Accepted OAuth Scopes**: `project`, `read:project`
1016-
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1017-
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
1018-
- `fields`: Field IDs to include (e.g. ["102589", "985201"]). CRITICAL: Always provide to get field values. Without this, only titles returned. (string[], optional)
912+
- `field_id`: The field's ID. Required for 'get_project_field' method. (number, optional)
913+
- `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)
914+
- `item_id`: The item's ID. Required for 'get_project_item' method. (number, optional)
915+
- `method`: The method to execute (string, required)
1019916
- `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)
1020917
- `owner_type`: Owner type (string, required)
1021-
- `per_page`: Results per page (max 50) (number, optional)
1022918
- `project_number`: The project's number. (number, required)
1023-
- `query`: Query string for advanced filtering of project items using GitHub's project filtering syntax. (string, optional)
1024919

1025-
- **list_projects** - List projects
920+
- **projects_list** - List GitHub Projects resources
1026921
- **Required OAuth Scopes**: `read:project`
1027922
- **Accepted OAuth Scopes**: `project`, `read:project`
1028923
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1029924
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
925+
- `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)
926+
- `method`: The action to perform (string, required)
1030927
- `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)
1031928
- `owner_type`: Owner type (string, required)
1032929
- `per_page`: Results per page (max 50) (number, optional)
1033-
- `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)
930+
- `project_number`: The project's number. Required for 'list_project_fields' and 'list_project_items' methods. (number, optional)
931+
- `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)
1034932

1035-
- **update_project_item** - Update project item
933+
- **projects_write** - Modify GitHub Project items
1036934
- **Required OAuth Scopes**: `project`
1037-
- `item_id`: The unique identifier of the project item. This is not the issue or pull request ID. (number, required)
935+
- `item_id`: The project item ID. Required for 'update_project_item' and 'delete_project_item' methods. For add_project_item, this is the numeric ID of the issue or pull request to add. (number, optional)
936+
- `item_type`: The item's type, either issue or pull_request. Required for 'add_project_item' method. (string, optional)
937+
- `method`: The method to execute (string, required)
1038938
- `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)
1039939
- `owner_type`: Owner type (string, required)
1040940
- `project_number`: The project's number. (number, required)
1041-
- `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)
941+
- `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)
1042942

1043943
</details>
1044944

0 commit comments

Comments
 (0)