Skip to content

Commit 7b30c93

Browse files
mattdhollowaySamMorrowDrums
authored andcommitted
update docs
1 parent 304f074 commit 7b30c93

File tree

2 files changed

+9
-29
lines changed

2 files changed

+9
-29
lines changed

README.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,35 +1000,6 @@ The following sets of tools are available:
10001000
- `per_page`: Results per page (max 50) (number, optional)
10011001
- `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)
10021002

1003-
- **projects_get** - Get details of GitHub Projects resources
1004-
- `field_id`: The field's ID. Required for 'get_project_field' method. (number, optional)
1005-
- `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)
1006-
- `item_id`: The item's ID. Required for 'get_project_item' method. (number, optional)
1007-
- `method`: The method to execute (string, required)
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-
- `project_number`: The project's number. (number, required)
1011-
1012-
- **projects_list** - List GitHub Projects resources
1013-
- `after`: Forward pagination cursor from previous pageInfo.nextCursor. (string, optional)
1014-
- `before`: Backward pagination cursor from previous pageInfo.prevCursor (rare). (string, optional)
1015-
- `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)
1016-
- `method`: The action to perform (string, required)
1017-
- `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)
1018-
- `owner_type`: Owner type (string, required)
1019-
- `per_page`: Results per page (max 50) (number, optional)
1020-
- `project_number`: The project's number. Required for 'list_project_fields' and 'list_project_items' methods. (number, optional)
1021-
- `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)
1022-
1023-
- **projects_write** - Modify GitHub Project items
1024-
- `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)
1025-
- `item_type`: The item's type, either issue or pull_request. Required for 'add_project_item' method. (string, optional)
1026-
- `method`: The method to execute (string, required)
1027-
- `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)
1028-
- `owner_type`: Owner type (string, required)
1029-
- `project_number`: The project's number. (number, required)
1030-
- `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)
1031-
10321003
- **update_project_item** - Update project item
10331004
- **Required OAuth Scopes**: `project`
10341005
- `item_id`: The unique identifier of the project item. This is not the issue or pull request ID. (number, required)

docs/tool-renaming.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,29 @@ Will get `issue_read` and `get_file_contents` tools registered, with no errors.
4646
<!-- START AUTOMATED ALIASES -->
4747
| Old Name | New Name |
4848
|----------|----------|
49+
| `add_project_item` | `projects_write` |
4950
| `cancel_workflow_run` | `actions_run_trigger` |
51+
| `delete_project_item` | `projects_write` |
5052
| `delete_workflow_run_logs` | `actions_run_trigger` |
5153
| `download_workflow_run_artifact` | `actions_get` |
54+
| `get_project` | `projects_get` |
55+
| `get_project_field` | `projects_get` |
56+
| `get_project_item` | `projects_get` |
5257
| `get_workflow` | `actions_get` |
5358
| `get_workflow_job` | `actions_get` |
5459
| `get_workflow_job_logs` | `actions_get` |
5560
| `get_workflow_run` | `actions_get` |
5661
| `get_workflow_run_logs` | `actions_get` |
5762
| `get_workflow_run_usage` | `actions_get` |
63+
| `list_project_fields` | `projects_list` |
64+
| `list_project_items` | `projects_list` |
65+
| `list_projects` | `projects_list` |
5866
| `list_workflow_jobs` | `actions_list` |
5967
| `list_workflow_run_artifacts` | `actions_list` |
6068
| `list_workflow_runs` | `actions_list` |
6169
| `list_workflows` | `actions_list` |
6270
| `rerun_failed_jobs` | `actions_run_trigger` |
6371
| `rerun_workflow_run` | `actions_run_trigger` |
6472
| `run_workflow` | `actions_run_trigger` |
73+
| `update_project_item` | `projects_write` |
6574
<!-- END AUTOMATED ALIASES -->

0 commit comments

Comments
 (0)