@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 04:45 UTC

next
json 77,114 lines 2.92 MB
Raw
Large file — syntax highlighting disabled.
1 [
2 {
3 "available_versions": ["latest"],
4 "name": "Accept a repository invitation",
5 "slug": "GITHUB_ACCEPT_A_REPOSITORY_INVITATION",
6 "input_parameters": {
7 "description": "Request schema for accepting a repository invitation.",
8 "properties": {
9 "invitation_id": {
10 "description": "Unique identifier of the repository invitation. Obtain by listing pending invitations for the authenticated user.",
11 "examples": ["12345", "67890"],
12 "title": "Invitation Id",
13 "type": "integer"
14 }
15 },
16 "required": ["invitation_id"],
17 "title": "AcceptARepositoryInvitationRequest",
18 "type": "object"
19 },
20 "output_parameters": {
21 "properties": {
22 "data": {
23 "additionalProperties": true,
24 "description": "GitHub API response. Usually empty for a successful acceptance (HTTP 204 No Content status).",
25 "title": "Data",
26 "type": "object"
27 },
28 "error": {
29 "default": null,
30 "description": "Error if any occurred during the execution of the action",
31 "nullable": true,
32 "title": "Error",
33 "type": "string"
34 },
35 "successful": {
36 "description": "Whether or not the action execution was successful or not",
37 "title": "Successful",
38 "type": "boolean"
39 }
40 },
41 "required": ["data", "successful"],
42 "title": "AcceptARepositoryInvitationResponseWrapper",
43 "type": "object"
44 },
45 "description": "Accepts a pending repository invitation that has been issued to the authenticated user.",
46 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "Invitations", "mcpIgnore"]
47 },
48 {
49 "available_versions": ["latest"],
50 "name": "List repositories starred by the authenticated user",
51 "slug": "GITHUB_ACTIVITY_LIST_REPO_S_STARRED_BY_AUTHENTICATED_USER",
52 "input_parameters": {
53 "description": "Request schema for `ListRepositoriesStarredByTheAuthenticatedUser`",
54 "properties": {
55 "direction": {
56 "default": "desc",
57 "description": "Sort direction: 'asc' (ascending) or 'desc' (descending).",
58 "enum": ["asc", "desc"],
59 "examples": ["asc", "desc"],
60 "title": "Direction",
61 "type": "string"
62 },
63 "page": {
64 "default": 1,
65 "description": "Page number of results (starts from 1).",
66 "examples": ["1", "2", "5"],
67 "title": "Page",
68 "type": "integer"
69 },
70 "per_page": {
71 "default": 1,
72 "description": "Number of results per page (max 100).",
73 "examples": ["30", "50", "100"],
74 "title": "Per Page",
75 "type": "integer"
76 },
77 "sort": {
78 "default": "created",
79 "description": "Sorts starred repositories by 'created' (date starred) or 'updated' (date last pushed).",
80 "enum": ["created", "updated"],
81 "examples": ["created", "updated"],
82 "title": "Sort",
83 "type": "string"
84 }
85 },
86 "title": "ListRepositoriesStarredByTheAuthenticatedUserRequest",
87 "type": "object"
88 },
89 "output_parameters": {
90 "properties": {
91 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
92 "error": {
93 "default": null,
94 "description": "Error if any occurred during the execution of the action",
95 "nullable": true,
96 "title": "Error",
97 "type": "string"
98 },
99 "successful": {
100 "description": "Whether or not the action execution was successful or not",
101 "title": "Successful",
102 "type": "boolean"
103 }
104 },
105 "required": ["data", "successful"],
106 "title": "ListRepositoriesStarredByTheAuthenticatedUserResponseWrapper",
107 "type": "object"
108 },
109 "description": "Deprecated: lists repositories starred by the authenticated user, including star creation timestamps; use 'list repositories starred by the authenticated user' instead.",
110 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Stars", "mcpIgnore"]
111 },
112 {
113 "available_versions": ["latest"],
114 "name": "List stargazers",
115 "slug": "GITHUB_ACTIVITY_LIST_STARGAZERS_FOR_REPO",
116 "input_parameters": {
117 "description": "Specifies the target repository and pagination preferences for listing stargazers.",
118 "properties": {
119 "owner": {
120 "description": "Username of the account owner (user or organization) of the repository; case-insensitive.",
121 "examples": ["octocat", "google"],
122 "title": "Owner",
123 "type": "string"
124 },
125 "page": {
126 "default": 1,
127 "description": "Page number of the results to fetch.",
128 "examples": ["1", "2", "10"],
129 "title": "Page",
130 "type": "integer"
131 },
132 "per_page": {
133 "default": 30,
134 "description": "Number of results to display per page (max 100).",
135 "examples": ["30", "50", "100"],
136 "title": "Per Page",
137 "type": "integer"
138 },
139 "repo": {
140 "description": "Name of the repository, without the `.git` extension; case-insensitive.",
141 "examples": ["Spoon-Knife", "mercury"],
142 "title": "Repo",
143 "type": "string"
144 }
145 },
146 "required": ["owner", "repo"],
147 "title": "ListStargazersRequest",
148 "type": "object"
149 },
150 "output_parameters": {
151 "properties": {
152 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
153 "error": {
154 "default": null,
155 "description": "Error if any occurred during the execution of the action",
156 "nullable": true,
157 "title": "Error",
158 "type": "string"
159 },
160 "successful": {
161 "description": "Whether or not the action execution was successful or not",
162 "title": "Successful",
163 "type": "boolean"
164 }
165 },
166 "required": ["data", "successful"],
167 "title": "ListStargazersResponseWrapper",
168 "type": "object"
169 },
170 "description": "Deprecated: lists users who have starred a repository; use `list stargazers` instead.",
171 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Stars", "mcpIgnore"]
172 },
173 {
174 "available_versions": ["latest"],
175 "name": "Star a repository for the authenticated user",
176 "slug": "GITHUB_ACTIVITY_STAR_REPO_FOR_AUTHENTICATED_USER",
177 "input_parameters": {
178 "description": "Request schema for starring a repository for the authenticated user.",
179 "properties": {
180 "owner": {
181 "description": "The username of the account that owns the repository. This field is not case-sensitive.",
182 "examples": ["octocat", "torvalds"],
183 "title": "Owner",
184 "type": "string"
185 },
186 "repo": {
187 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
188 "examples": ["hello-world", "linux"],
189 "title": "Repo",
190 "type": "string"
191 }
192 },
193 "required": ["owner", "repo"],
194 "title": "StarARepositoryForTheAuthenticatedUserRequest",
195 "type": "object"
196 },
197 "output_parameters": {
198 "properties": {
199 "data": {
200 "additionalProperties": true,
201 "description": "A dictionary containing the API response data. Upon a successful star operation (HTTP 204 No Content), this field will typically be an empty dictionary or not populated.",
202 "title": "Data",
203 "type": "object"
204 },
205 "error": {
206 "default": null,
207 "description": "Error if any occurred during the execution of the action",
208 "nullable": true,
209 "title": "Error",
210 "type": "string"
211 },
212 "successful": {
213 "description": "Whether or not the action execution was successful or not",
214 "title": "Successful",
215 "type": "boolean"
216 }
217 },
218 "required": ["data", "successful"],
219 "title": "StarARepositoryForTheAuthenticatedUserResponseWrapper",
220 "type": "object"
221 },
222 "description": "Deprecated: stars a repository for the authenticated user; use `star a repository for the authenticated user` instead.",
223 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Stars", "mcpIgnore"]
224 },
225 {
226 "available_versions": ["latest"],
227 "name": "Add email for auth user",
228 "slug": "GITHUB_ADD_AN_EMAIL_ADDRESS_FOR_THE_AUTHENTICATED_USER",
229 "input_parameters": {
230 "description": "Specifies the email addresses to be added to the authenticated user's GitHub account.",
231 "properties": {
232 "emails": {
233 "items": { "properties": {}, "type": "string" },
234 "title": "Emails",
235 "type": "array"
236 }
237 },
238 "required": ["emails"],
239 "title": "AddAnEmailAddressForTheAuthenticatedUserRequest",
240 "type": "object"
241 },
242 "output_parameters": {
243 "properties": {
244 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
245 "error": {
246 "default": null,
247 "description": "Error if any occurred during the execution of the action",
248 "nullable": true,
249 "title": "Error",
250 "type": "string"
251 },
252 "successful": {
253 "description": "Whether or not the action execution was successful or not",
254 "title": "Successful",
255 "type": "boolean"
256 }
257 },
258 "required": ["data", "successful"],
259 "title": "AddAnEmailAddressForTheAuthenticatedUserResponseWrapper",
260 "type": "object"
261 },
262 "description": "Adds one or more email addresses (which will be initially unverified) to the authenticated user's github account; use this to associate new emails, noting an email verified for another account will error, while an existing email for the current user is accepted.",
263 "tags": ["updateHint", "openWorldHint", "important", "Users"]
264 },
265 {
266 "available_versions": ["latest"],
267 "name": "Add app access restrictions",
268 "slug": "GITHUB_ADD_APP_ACCESS_RESTRICTIONS",
269 "input_parameters": {
270 "description": "Request schema defining the target repository and branch for applying app access restrictions.",
271 "properties": {
272 "branch": {
273 "description": "The name of the branch to which restrictions will be applied. Wildcard characters (e.g., '*') are not allowed in the branch name when using this REST API endpoint. For operations involving wildcard branch names, consult the GitHub GraphQL API.",
274 "examples": ["main"],
275 "title": "Branch",
276 "type": "string"
277 },
278 "owner": {
279 "description": "The username or organization name that owns the repository. This field is not case-sensitive.",
280 "examples": ["octocat"],
281 "title": "Owner",
282 "type": "string"
283 },
284 "repo": {
285 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
286 "examples": ["hello-world"],
287 "title": "Repo",
288 "type": "string"
289 }
290 },
291 "required": ["owner", "repo", "branch"],
292 "title": "AddAppAccessRestrictionsRequest",
293 "type": "object"
294 },
295 "output_parameters": {
296 "properties": {
297 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
298 "error": {
299 "default": null,
300 "description": "Error if any occurred during the execution of the action",
301 "nullable": true,
302 "title": "Error",
303 "type": "string"
304 },
305 "successful": {
306 "description": "Whether or not the action execution was successful or not",
307 "title": "Successful",
308 "type": "boolean"
309 }
310 },
311 "required": ["data", "successful"],
312 "title": "AddAppAccessRestrictionsResponseWrapper",
313 "type": "object"
314 },
315 "description": "Replaces github app access restrictions for an existing protected branch; requires a json array of app slugs in the request body, where apps must be installed and have 'contents' write permissions.",
316 "tags": ["updateHint", "openWorldHint", "Repositories", "mcpIgnore"]
317 },
318 {
319 "available_versions": ["latest"],
320 "name": "Add assignees to an issue",
321 "slug": "GITHUB_ADD_ASSIGNEES_TO_AN_ISSUE",
322 "input_parameters": {
323 "description": "Request model for adding assignees to a GitHub issue.",
324 "properties": {
325 "assignees": {
326 "description": "A list of GitHub usernames to assign to the issue. Up to 10 assignees can be specified. Pass an empty list `[]` to remove all current assignees. _NOTE: The authenticated user must have push access to the repository to modify assignees. If the user lacks this permission, changes to assignees will be silently ignored._",
327 "examples": [["octocat", "hubot"], ["dev-user1"], []],
328 "items": { "properties": {}, "type": "string" },
329 "title": "Assignees",
330 "type": "array"
331 },
332 "issue_number": {
333 "description": "The unique number identifying the issue within the repository.",
334 "examples": ["123", "42"],
335 "title": "Issue Number",
336 "type": "integer"
337 },
338 "owner": {
339 "description": "The username of the account or the organization name that owns the repository. This field is not case sensitive.",
340 "examples": ["octocat", "my-company"],
341 "title": "Owner",
342 "type": "string"
343 },
344 "repo": {
345 "description": "The name of the repository, without the `.git` extension. This field is not case sensitive.",
346 "examples": ["hello-world", "my-internal-project"],
347 "title": "Repo",
348 "type": "string"
349 }
350 },
351 "required": ["owner", "repo", "issue_number"],
352 "title": "AddAssigneesToAnIssueRequest",
353 "type": "object"
354 },
355 "output_parameters": {
356 "properties": {
357 "data": {
358 "additionalProperties": true,
359 "description": "A dictionary containing the API response data, typically representing the full issue object with its updated list of assignees.",
360 "title": "Data",
361 "type": "object"
362 },
363 "error": {
364 "default": null,
365 "description": "Error if any occurred during the execution of the action",
366 "nullable": true,
367 "title": "Error",
368 "type": "string"
369 },
370 "successful": {
371 "description": "Whether or not the action execution was successful or not",
372 "title": "Successful",
373 "type": "boolean"
374 }
375 },
376 "required": ["data", "successful"],
377 "title": "AddAssigneesToAnIssueResponseWrapper",
378 "type": "object"
379 },
380 "description": "Adds or removes assignees for a github issue; changes are silently ignored if the authenticated user lacks push access to the repository.",
381 "tags": ["idempotentHint", "updateHint", "openWorldHint", "important", "Issues"]
382 },
383 {
384 "available_versions": ["latest"],
385 "name": "Add a repository collaborator",
386 "slug": "GITHUB_ADD_A_REPOSITORY_COLLABORATOR",
387 "input_parameters": {
388 "description": "Request schema for adding a collaborator to a GitHub repository.",
389 "properties": {
390 "owner": {
391 "description": "The account owner of the repository. This name is not case sensitive.",
392 "title": "Owner",
393 "type": "string"
394 },
395 "permission": {
396 "default": "push",
397 "description": "Permission level for the collaborator. For organization-owned repositories, valid values are `pull` (read-only), `triage` (manage issues/PRs), `push` (read/write), `maintain` (manage most settings), `admin` (full control), or a custom repository role name if defined by the owning organization. This parameter is ignored for personal repositories, which grant `push` access.",
398 "examples": ["pull", "triage", "push", "maintain", "admin", "custom_role_name"],
399 "title": "Permission",
400 "type": "string"
401 },
402 "repo": {
403 "description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
404 "title": "Repo",
405 "type": "string"
406 },
407 "username": {
408 "description": "The GitHub handle for the user account to add as a collaborator.",
409 "title": "Username",
410 "type": "string"
411 }
412 },
413 "required": ["owner", "repo", "username"],
414 "title": "AddARepositoryCollaboratorRequest",
415 "type": "object"
416 },
417 "output_parameters": {
418 "properties": {
419 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
420 "error": {
421 "default": null,
422 "description": "Error if any occurred during the execution of the action",
423 "nullable": true,
424 "title": "Error",
425 "type": "string"
426 },
427 "successful": {
428 "description": "Whether or not the action execution was successful or not",
429 "title": "Successful",
430 "type": "boolean"
431 }
432 },
433 "required": ["data", "successful"],
434 "title": "AddARepositoryCollaboratorResponseWrapper",
435 "type": "object"
436 },
437 "description": "Adds a github user as a repository collaborator, or updates their permission if already a collaborator; `permission` applies to organization-owned repositories (personal ones default to 'push' and ignore this field), and an invitation may be created or permissions updated directly.",
438 "tags": ["updateHint", "openWorldHint", "important", "Repositories"]
439 },
440 {
441 "available_versions": ["latest"],
442 "name": "Add a repository to an app installation",
443 "slug": "GITHUB_ADD_A_REPOSITORY_TO_AN_APP_INSTALLATION",
444 "input_parameters": {
445 "description": "Request to add a repository to a GitHub App installation for the authenticated user.",
446 "properties": {
447 "installation_id": {
448 "description": "The unique identifier of the GitHub App installation to which the repository will be added. This installation must be accessible to the authenticated user.",
449 "examples": ["1234567", "8765432"],
450 "title": "Installation Id",
451 "type": "integer"
452 },
453 "repository_id": {
454 "description": "The unique identifier of the repository to add to the installation. The authenticated user must have admin permissions for this repository.",
455 "examples": ["9876543", "2345678"],
456 "title": "Repository Id",
457 "type": "integer"
458 }
459 },
460 "required": ["installation_id", "repository_id"],
461 "title": "AddARepositoryToAnAppInstallationRequest",
462 "type": "object"
463 },
464 "output_parameters": {
465 "properties": {
466 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
467 "error": {
468 "default": null,
469 "description": "Error if any occurred during the execution of the action",
470 "nullable": true,
471 "title": "Error",
472 "type": "string"
473 },
474 "successful": {
475 "description": "Whether or not the action execution was successful or not",
476 "title": "Successful",
477 "type": "boolean"
478 }
479 },
480 "required": ["data", "successful"],
481 "title": "AddARepositoryToAnAppInstallationResponseWrapper",
482 "type": "object"
483 },
484 "description": "Adds a repository to a github app installation, granting the app access; requires authenticated user to have admin rights for the repository and access to the installation.",
485 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Repositories", "mcpIgnore"]
486 },
487 {
488 "available_versions": ["latest"],
489 "name": "Add a selected repository to a user secret",
490 "slug": "GITHUB_ADD_A_SELECTED_REPOSITORY_TO_A_USER_SECRET",
491 "input_parameters": {
492 "description": "Request schema for `AddASelectedRepositoryToAUserSecret`",
493 "properties": {
494 "repository_id": {
495 "description": "The unique identifier of the repository to be granted access to the specified user-level Codespaces secret.",
496 "examples": [1296269, 490940582],
497 "title": "Repository Id",
498 "type": "integer"
499 },
500 "secret_name": {
501 "description": "Name of the user-level Codespaces secret to which repository access is added; this secret must already exist for the authenticated user.",
502 "examples": ["GH_TOKEN_MY_USER", "PERSONAL_API_KEY"],
503 "title": "Secret Name",
504 "type": "string"
505 }
506 },
507 "required": ["secret_name", "repository_id"],
508 "title": "AddASelectedRepositoryToAUserSecretRequest",
509 "type": "object"
510 },
511 "output_parameters": {
512 "properties": {
513 "data": {
514 "additionalProperties": true,
515 "description": "The response data from the API. On successful execution (HTTP 204 No Content), this field is typically empty.",
516 "title": "Data",
517 "type": "object"
518 },
519 "error": {
520 "default": null,
521 "description": "Error if any occurred during the execution of the action",
522 "nullable": true,
523 "title": "Error",
524 "type": "string"
525 },
526 "successful": {
527 "description": "Whether or not the action execution was successful or not",
528 "title": "Successful",
529 "type": "boolean"
530 }
531 },
532 "required": ["data", "successful"],
533 "title": "AddASelectedRepositoryToAUserSecretResponseWrapper",
534 "type": "object"
535 },
536 "description": "Grants a specified repository access to an authenticated user's existing codespaces secret, enabling codespaces created for that repository to use the secret.",
537 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Code Spaces", "mcpIgnore"]
538 },
539 {
540 "available_versions": ["latest"],
541 "name": "Add labels to an issue",
542 "slug": "GITHUB_ADD_LABELS_TO_AN_ISSUE",
543 "input_parameters": {
544 "description": "Specifies the repository issue to which labels will be added.",
545 "properties": {
546 "issue_number": {
547 "description": "Number that uniquely identifies the issue within the repository.",
548 "examples": ["42", "101"],
549 "title": "Issue Number",
550 "type": "integer"
551 },
552 "owner": {
553 "description": "Username or organization name owning the repository (case-insensitive).",
554 "examples": ["octocat", "my-organization"],
555 "title": "Owner",
556 "type": "string"
557 },
558 "repo": {
559 "description": "Repository name, without the `.git` extension (case-insensitive).",
560 "examples": ["Spoon-Knife", "my-awesome-project"],
561 "title": "Repo",
562 "type": "string"
563 }
564 },
565 "required": ["owner", "repo", "issue_number"],
566 "title": "AddLabelsToAnIssueRequest",
567 "type": "object"
568 },
569 "output_parameters": {
570 "properties": {
571 "data": {
572 "additionalProperties": true,
573 "description": "The API response data, which includes all labels currently applied to the issue.",
574 "title": "Data",
575 "type": "object"
576 },
577 "error": {
578 "default": null,
579 "description": "Error if any occurred during the execution of the action",
580 "nullable": true,
581 "title": "Error",
582 "type": "string"
583 },
584 "successful": {
585 "description": "Whether or not the action execution was successful or not",
586 "title": "Successful",
587 "type": "boolean"
588 }
589 },
590 "required": ["data", "successful"],
591 "title": "AddLabelsToAnIssueResponseWrapper",
592 "type": "object"
593 },
594 "description": "Adds labels (provided in the request body) to a repository issue; labels that do not already exist are created.",
595 "tags": ["idempotentHint", "updateHint", "openWorldHint", "important", "Issues"]
596 },
597 {
598 "available_versions": ["latest"],
599 "name": "Add org runner labels",
600 "slug": "GITHUB_ADD_ORG_RUNNER_LABELS",
601 "input_parameters": {
602 "description": "Request schema for adding custom labels to a self-hosted runner for an organization.",
603 "properties": {
604 "labels": {
605 "description": "A list of custom label names to add to the self-hosted runner. Previously applied labels are not removed.",
606 "examples": [["new-label", "gpu-runner"]],
607 "items": { "properties": {}, "type": "string" },
608 "title": "Labels",
609 "type": "array"
610 },
611 "org": {
612 "description": "The organization's name (case-insensitive).",
613 "examples": ["my-org-name"],
614 "title": "Org",
615 "type": "string"
616 },
617 "runner_id": {
618 "description": "Unique identifier of the self-hosted runner.",
619 "examples": [12345],
620 "title": "Runner Id",
621 "type": "integer"
622 }
623 },
624 "required": ["org", "runner_id", "labels"],
625 "title": "AddOrgRunnerLabelsRequest",
626 "type": "object"
627 },
628 "output_parameters": {
629 "properties": {
630 "data": {
631 "additionalProperties": true,
632 "description": "A dictionary containing the updated list of labels for the runner. This typically includes a 'total_count' of labels and a 'labels' array, where each element is an object detailing a label (e.g., its ID, name, and type).",
633 "title": "Data",
634 "type": "object"
635 },
636 "error": {
637 "default": null,
638 "description": "Error if any occurred during the execution of the action",
639 "nullable": true,
640 "title": "Error",
641 "type": "string"
642 },
643 "successful": {
644 "description": "Whether or not the action execution was successful or not",
645 "title": "Successful",
646 "type": "boolean"
647 }
648 },
649 "required": ["data", "successful"],
650 "title": "AddOrgRunnerLabelsResponseWrapper",
651 "type": "object"
652 },
653 "description": "Adds new custom labels to an existing self-hosted runner for an organization; existing labels are not removed, and duplicates are not added.",
654 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Workflows", "mcpIgnore"]
655 },
656 {
657 "available_versions": ["latest"],
658 "name": "Add or update team membership for a user",
659 "slug": "GITHUB_ADD_OR_UPDATE_TEAM_MEMBERSHIP_FOR_A_USER",
660 "input_parameters": {
661 "description": "Request schema for `AddOrUpdateTeamMembershipForAUser`",
662 "properties": {
663 "org": {
664 "description": "The name of the GitHub organization. This name is not case-sensitive.",
665 "examples": ["github-org", "octo-corp"],
666 "title": "Org",
667 "type": "string"
668 },
669 "role": {
670 "default": "member",
671 "description": "The role to assign to the user within the team. A 'maintainer' has broader permissions than a 'member', such as managing team members and settings.",
672 "enum": ["member", "maintainer"],
673 "examples": ["member", "maintainer"],
674 "title": "Role",
675 "type": "string"
676 },
677 "team_slug": {
678 "description": "The slug (URL-friendly version) of the team's name.",
679 "examples": ["justice-league", "developers", "product-team"],
680 "title": "Team Slug",
681 "type": "string"
682 },
683 "username": {
684 "description": "The GitHub username of the user to add or whose membership to update.",
685 "examples": ["octocat", "mona-lisa-fixed"],
686 "title": "Username",
687 "type": "string"
688 }
689 },
690 "required": ["org", "team_slug", "username"],
691 "title": "AddOrUpdateTeamMembershipForAUserRequest",
692 "type": "object"
693 },
694 "output_parameters": {
695 "properties": {
696 "data": {
697 "additionalProperties": true,
698 "description": "A dictionary representing the team membership details for the user, including their role and current membership state (e.g., 'active', 'pending').",
699 "title": "Data",
700 "type": "object"
701 },
702 "error": {
703 "default": null,
704 "description": "Error if any occurred during the execution of the action",
705 "nullable": true,
706 "title": "Error",
707 "type": "string"
708 },
709 "successful": {
710 "description": "Whether or not the action execution was successful or not",
711 "title": "Successful",
712 "type": "boolean"
713 }
714 },
715 "required": ["data", "successful"],
716 "title": "AddOrUpdateTeamMembershipForAUserResponseWrapper",
717 "type": "object"
718 },
719 "description": "Adds a github user to a team or updates their role (member or maintainer), inviting them to the organization if not already a member; idempotent, returning current details if no change is made.",
720 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
721 },
722 {
723 "available_versions": ["latest"],
724 "name": "Add or update team project permissions",
725 "slug": "GITHUB_ADD_OR_UPDATE_TEAM_PROJECT_PERMISSIONS",
726 "input_parameters": {
727 "description": "Grants or updates a team's permissions for a specific project.",
728 "properties": {
729 "org": {
730 "description": "Name of the organization (case-insensitive).",
731 "examples": ["octo-org"],
732 "title": "Org",
733 "type": "string"
734 },
735 "permission": {
736 "description": "Permission level to grant ('read', 'write', or 'admin'). Uses the team's default permission if not provided.",
737 "enum": ["read", "write", "admin"],
738 "examples": ["read", "write", "admin"],
739 "title": "Permission",
740 "type": "string"
741 },
742 "project_id": {
743 "description": "Unique identifier of the project.",
744 "examples": [1002604],
745 "title": "Project Id",
746 "type": "integer"
747 },
748 "team_slug": {
749 "description": "URL-friendly identifier (slug) for the team.",
750 "examples": ["justice-league"],
751 "title": "Team Slug",
752 "type": "string"
753 }
754 },
755 "required": ["org", "team_slug", "project_id"],
756 "title": "AddOrUpdateTeamProjectPermissionsRequest",
757 "type": "object"
758 },
759 "output_parameters": {
760 "properties": {
761 "data": {
762 "additionalProperties": true,
763 "description": "Response data. A successful update (HTTP 204 No Content) typically results in an empty body.",
764 "title": "Data",
765 "type": "object"
766 },
767 "error": {
768 "default": null,
769 "description": "Error if any occurred during the execution of the action",
770 "nullable": true,
771 "title": "Error",
772 "type": "string"
773 },
774 "successful": {
775 "description": "Whether or not the action execution was successful or not",
776 "title": "Successful",
777 "type": "boolean"
778 }
779 },
780 "required": ["successful"],
781 "title": "AddOrUpdateTeamProjectPermissionsResponseWrapper",
782 "type": "object"
783 },
784 "description": "Grants or updates a team's permissions ('read', 'write', or 'admin') for a specific project, which must exist within the specified organization and be linked to it.",
785 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
786 },
787 {
788 "available_versions": ["latest"],
789 "name": "Add or update team repository permissions",
790 "slug": "GITHUB_ADD_OR_UPDATE_TEAM_REPOSITORY_PERMISSIONS",
791 "input_parameters": {
792 "description": "Request schema for `AddOrUpdateTeamRepositoryPermissions`",
793 "properties": {
794 "org": {
795 "description": "Organization's name (case-insensitive).",
796 "examples": ["octo-org", "github"],
797 "title": "Org",
798 "type": "string"
799 },
800 "owner": {
801 "description": "Username of the account owning the repository (case-insensitive).",
802 "examples": ["octocat", "my-organization"],
803 "title": "Owner",
804 "type": "string"
805 },
806 "permission": {
807 "default": "push",
808 "description": "Permission to grant the team. Options: 'pull' (read-only), 'triage' (manage issues/PRs), 'push' (read/write), 'maintain' (manage repo settings, plus push), 'admin' (full control), or a custom repository role name.",
809 "examples": ["admin", "push", "maintain", "custom-role-123"],
810 "title": "Permission",
811 "type": "string"
812 },
813 "repo": {
814 "description": "Repository name, without the `.git` extension (case-insensitive).",
815 "examples": ["hello-world", "my-awesome-project"],
816 "title": "Repo",
817 "type": "string"
818 },
819 "team_slug": {
820 "description": "The team's slug (URL-friendly name).",
821 "examples": ["justice-league", "developers"],
822 "title": "Team Slug",
823 "type": "string"
824 }
825 },
826 "required": ["org", "team_slug", "owner", "repo"],
827 "title": "AddOrUpdateTeamRepositoryPermissionsRequest",
828 "type": "object"
829 },
830 "output_parameters": {
831 "properties": {
832 "data": {
833 "additionalProperties": true,
834 "description": "API response data. Usually an empty dictionary for successful updates (HTTP 204 No Content).",
835 "title": "Data",
836 "type": "object"
837 },
838 "error": {
839 "default": null,
840 "description": "Error if any occurred during the execution of the action",
841 "nullable": true,
842 "title": "Error",
843 "type": "string"
844 },
845 "successful": {
846 "description": "Whether or not the action execution was successful or not",
847 "title": "Successful",
848 "type": "boolean"
849 }
850 },
851 "required": ["successful"],
852 "title": "AddOrUpdateTeamRepositoryPermissionsResponseWrapper",
853 "type": "object"
854 },
855 "description": "Sets or updates a team's permission level for a repository within an organization; the team must be a member of the organization.",
856 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
857 },
858 {
859 "available_versions": ["latest"],
860 "name": "Add project collaborator",
861 "slug": "GITHUB_ADD_PROJECT_COLLABORATOR",
862 "input_parameters": {
863 "description": "Request to add a collaborator to an organization project.",
864 "properties": {
865 "permission": {
866 "default": "write",
867 "description": "Permission level for the collaborator on the project.",
868 "enum": ["read", "write", "admin"],
869 "examples": ["read", "write", "admin"],
870 "title": "Permission",
871 "type": "string"
872 },
873 "project_id": {
874 "description": "The unique identifier of the organization project.",
875 "examples": ["12345"],
876 "title": "Project Id",
877 "type": "integer"
878 },
879 "username": {
880 "description": "The GitHub username of the user to be added as a collaborator.",
881 "examples": ["octocat"],
882 "title": "Username",
883 "type": "string"
884 }
885 },
886 "required": ["project_id", "username"],
887 "title": "AddProjectCollaboratorRequest",
888 "type": "object"
889 },
890 "output_parameters": {
891 "properties": {
892 "data": {
893 "additionalProperties": true,
894 "description": "API response data; typically empty on success (204 No Content).",
895 "title": "Data",
896 "type": "object"
897 },
898 "error": {
899 "default": null,
900 "description": "Error if any occurred during the execution of the action",
901 "nullable": true,
902 "title": "Error",
903 "type": "string"
904 },
905 "successful": {
906 "description": "Whether or not the action execution was successful or not",
907 "title": "Successful",
908 "type": "boolean"
909 }
910 },
911 "required": ["data", "successful"],
912 "title": "AddProjectCollaboratorResponseWrapper",
913 "type": "object"
914 },
915 "description": "Adds a specified github user as a collaborator to an existing organization project with a given permission level.",
916 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
917 },
918 {
919 "available_versions": ["latest"],
920 "name": "Add repo to org secret with selected access",
921 "slug": "GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_ACCESS",
922 "input_parameters": {
923 "description": "Request schema for adding a repository to an organization secret with 'selected' access type.",
924 "properties": {
925 "org": {
926 "description": "The name of the GitHub organization. This field is not case-sensitive.",
927 "examples": ["MyOrganization", "Octo-Org"],
928 "title": "Org",
929 "type": "string"
930 },
931 "repository_id": {
932 "description": "The unique identifier of the repository to be granted access to the organization secret.",
933 "examples": [123456789, 987654321],
934 "title": "Repository Id",
935 "type": "integer"
936 },
937 "secret_name": {
938 "description": "The name of the organization secret to which the repository will be added.",
939 "examples": ["MY_API_KEY", "DATABASE_PASSWORD"],
940 "title": "Secret Name",
941 "type": "string"
942 }
943 },
944 "required": ["org", "secret_name", "repository_id"],
945 "title": "AddRepoToOrgSecretWithSelectedAccessRequest",
946 "type": "object"
947 },
948 "output_parameters": {
949 "properties": {
950 "data": {
951 "additionalProperties": true,
952 "description": "Response data from the API. For a successful operation (which typically returns a 204 No Content status), this field will likely be empty. In case of an error, it may contain error details.",
953 "title": "Data",
954 "type": "object"
955 },
956 "error": {
957 "default": null,
958 "description": "Error if any occurred during the execution of the action",
959 "nullable": true,
960 "title": "Error",
961 "type": "string"
962 },
963 "successful": {
964 "description": "Whether or not the action execution was successful or not",
965 "title": "Successful",
966 "type": "boolean"
967 }
968 },
969 "required": ["data", "successful"],
970 "title": "AddRepoToOrgSecretWithSelectedAccessResponseWrapper",
971 "type": "object"
972 },
973 "description": "Adds a repository to an existing organization-level github actions secret that is configured for 'selected' repository access.",
974 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Security", "mcpIgnore"]
975 },
976 {
977 "available_versions": ["latest"],
978 "name": "Add selected repo to org secret",
979 "slug": "GITHUB_ADD_REPO_TO_ORG_SECRET_WITH_SELECTED_VISIBILITY",
980 "input_parameters": {
981 "description": "Request schema for assigning a repository to an organization's Dependabot secret.",
982 "properties": {
983 "org": {
984 "description": "The organization's unique identifier (case-insensitive).",
985 "examples": ["octo-org"],
986 "title": "Org",
987 "type": "string"
988 },
989 "repository_id": {
990 "description": "Unique ID of the repository to be granted access to the secret.",
991 "examples": [1296269],
992 "title": "Repository Id",
993 "type": "integer"
994 },
995 "secret_name": {
996 "description": "Name of the Dependabot secret; must be alphanumeric or underscore, no spaces (lowercase auto-converts to uppercase).",
997 "examples": ["MY_SECRET_TOKEN", "ARTIFACTORY_PASSWORD"],
998 "title": "Secret Name",
999 "type": "string"
1000 }
1001 },
1002 "required": ["org", "secret_name", "repository_id"],
1003 "title": "AddRepoToOrgSecretWithSelectedVisibilityRequest",
1004 "type": "object"
1005 },
1006 "output_parameters": {
1007 "properties": {
1008 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1009 "error": {
1010 "default": null,
1011 "description": "Error if any occurred during the execution of the action",
1012 "nullable": true,
1013 "title": "Error",
1014 "type": "string"
1015 },
1016 "successful": {
1017 "description": "Whether or not the action execution was successful or not",
1018 "title": "Successful",
1019 "type": "boolean"
1020 }
1021 },
1022 "required": ["data", "successful"],
1023 "title": "AddRepoToOrgSecretWithSelectedVisibilityResponseWrapper",
1024 "type": "object"
1025 },
1026 "description": "Grants an existing repository access to an existing organization-level dependabot secret; the repository must belong to the organization, and the call succeeds without change if access already exists.",
1027 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Security", "mcpIgnore"]
1028 },
1029 {
1030 "available_versions": ["latest"],
1031 "name": "Add runner labels",
1032 "slug": "GITHUB_ADD_RUNNER_LABELS",
1033 "input_parameters": {
1034 "description": "Request schema for `AddCustomLabelsToASelfHostedRunnerForARepository`",
1035 "properties": {
1036 "labels": {
1037 "description": "Custom label names to add. Appended to existing labels. Names are case-insensitive. Empty list means no changes.",
1038 "examples": ["prod", "linux-x64", "gpu-enabled"],
1039 "items": { "properties": {}, "type": "string" },
1040 "title": "Labels",
1041 "type": "array"
1042 },
1043 "owner": {
1044 "description": "Username or organization name of the repository owner. Case-insensitive.",
1045 "examples": ["octocat", "MyOrganization"],
1046 "title": "Owner",
1047 "type": "string"
1048 },
1049 "repo": {
1050 "description": "Name of the repository, without the `.git` extension. Case-insensitive.",
1051 "examples": ["hello-world", "my-awesome-project"],
1052 "title": "Repo",
1053 "type": "string"
1054 },
1055 "runner_id": {
1056 "description": "Unique ID of the self-hosted runner.",
1057 "examples": ["123", "456"],
1058 "title": "Runner Id",
1059 "type": "integer"
1060 }
1061 },
1062 "required": ["owner", "repo", "runner_id", "labels"],
1063 "title": "AddRunnerLabelsRequest",
1064 "type": "object"
1065 },
1066 "output_parameters": {
1067 "properties": {
1068 "data": {
1069 "additionalProperties": true,
1070 "description": "Details of all custom labels on the runner after addition, typically including `total_count` and a list of label objects (each with `id`, `name`, `type`).",
1071 "title": "Data",
1072 "type": "object"
1073 },
1074 "error": {
1075 "default": null,
1076 "description": "Error if any occurred during the execution of the action",
1077 "nullable": true,
1078 "title": "Error",
1079 "type": "string"
1080 },
1081 "successful": {
1082 "description": "Whether or not the action execution was successful or not",
1083 "title": "Successful",
1084 "type": "boolean"
1085 }
1086 },
1087 "required": ["data", "successful"],
1088 "title": "AddRunnerLabelsResponseWrapper",
1089 "type": "object"
1090 },
1091 "description": "Adds and appends custom labels to a self-hosted repository runner, which must be registered and active.",
1092 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Workflows", "mcpIgnore"]
1093 },
1094 {
1095 "available_versions": ["latest"],
1096 "name": "Add selected repository to an organization secret",
1097 "slug": "GITHUB_ADD_SELECTED_REPOSITORY_TO_AN_ORGANIZATION_SECRET",
1098 "input_parameters": {
1099 "description": "Request schema for `AddSelectedRepositoryToAnOrganizationSecret`",
1100 "properties": {
1101 "org": {
1102 "description": "The name of the organization. This name is not case sensitive.",
1103 "examples": ["octo-org"],
1104 "title": "Org",
1105 "type": "string"
1106 },
1107 "repository_id": {
1108 "description": "The unique identifier of the repository to add to the secret's access list.",
1109 "examples": [1296269],
1110 "title": "Repository Id",
1111 "type": "integer"
1112 },
1113 "secret_name": {
1114 "description": "The name of the secret. Secret names can only contain alphanumeric characters ([A-Z], [a-z], [0-9]) or underscores (_). Spaces are not allowed. Secret names cannot start with GITHUB_ and must be less than 255 characters.",
1115 "examples": ["MY_API_KEY"],
1116 "title": "Secret Name",
1117 "type": "string"
1118 }
1119 },
1120 "required": ["org", "secret_name", "repository_id"],
1121 "title": "AddSelectedRepositoryToAnOrganizationSecretRequest",
1122 "type": "object"
1123 },
1124 "output_parameters": {
1125 "properties": {
1126 "data": {
1127 "additionalProperties": true,
1128 "description": "An empty dictionary, as this operation does not return a response body on success (HTTP 204 No Content).",
1129 "title": "Data",
1130 "type": "object"
1131 },
1132 "error": {
1133 "default": null,
1134 "description": "Error if any occurred during the execution of the action",
1135 "nullable": true,
1136 "title": "Error",
1137 "type": "string"
1138 },
1139 "successful": {
1140 "description": "Whether or not the action execution was successful or not",
1141 "title": "Successful",
1142 "type": "boolean"
1143 }
1144 },
1145 "required": ["data", "successful"],
1146 "title": "AddSelectedRepositoryToAnOrganizationSecretResponseWrapper",
1147 "type": "object"
1148 },
1149 "description": "Adds a repository to an organization secret's access list when the secret's visibility is 'selected'; this operation is idempotent.",
1150 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Code Spaces", "mcpIgnore"]
1151 },
1152 {
1153 "available_versions": ["latest"],
1154 "name": "Add selected repository to an organization variable",
1155 "slug": "GITHUB_ADD_SELECTED_REPOSITORY_TO_AN_ORGANIZATION_VARIABLE",
1156 "input_parameters": {
1157 "description": "Input for adding a selected repository to an organization variable's access list.",
1158 "properties": {
1159 "name": {
1160 "description": "Name of the existing organization-level GitHub Actions variable.",
1161 "examples": ["CI_DEPLOY_KEY", "SHARED_SECRET_VALUE"],
1162 "title": "Name",
1163 "type": "string"
1164 },
1165 "org": {
1166 "description": "Name of the GitHub organization (case-insensitive).",
1167 "examples": ["octo-org", "my-company"],
1168 "title": "Org",
1169 "type": "string"
1170 },
1171 "repository_id": {
1172 "description": "Unique identifier of the repository to grant access.",
1173 "examples": ["1296269", "543210"],
1174 "title": "Repository Id",
1175 "type": "integer"
1176 }
1177 },
1178 "required": ["org", "name", "repository_id"],
1179 "title": "AddSelectedRepositoryToAnOrganizationVariableRequest",
1180 "type": "object"
1181 },
1182 "output_parameters": {
1183 "properties": {
1184 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1185 "error": {
1186 "default": null,
1187 "description": "Error if any occurred during the execution of the action",
1188 "nullable": true,
1189 "title": "Error",
1190 "type": "string"
1191 },
1192 "successful": {
1193 "description": "Whether or not the action execution was successful or not",
1194 "title": "Successful",
1195 "type": "boolean"
1196 }
1197 },
1198 "required": ["data", "successful"],
1199 "title": "AddSelectedRepositoryToAnOrganizationVariableResponseWrapper",
1200 "type": "object"
1201 },
1202 "description": "Grants a repository access to an organization-level github actions variable, if that variable's visibility is set to 'selected repositories'.",
1203 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
1204 },
1205 {
1206 "available_versions": ["latest"],
1207 "name": "Add social accounts for the authenticated user",
1208 "slug": "GITHUB_ADD_SOCIAL_ACCOUNTS_FOR_THE_AUTHENTICATED_USER",
1209 "input_parameters": {
1210 "description": "Specifies the social media accounts to add for the authenticated user.",
1211 "properties": {
1212 "account_urls": {
1213 "description": "Full URLs for social media profiles to add to the user's GitHub profile; these will be displayed publicly.",
1214 "examples": [
1215 "https://twitter.com/github",
1216 "https://www.linkedin.com/in/github/",
1217 "https://mastodon.social/@github"
1218 ],
1219 "items": { "properties": {}, "type": "string" },
1220 "title": "Account Urls",
1221 "type": "array"
1222 }
1223 },
1224 "required": ["account_urls"],
1225 "title": "AddSocialAccountsForTheAuthenticatedUserRequest",
1226 "type": "object"
1227 },
1228 "output_parameters": {
1229 "properties": {
1230 "data": {
1231 "additionalProperties": true,
1232 "description": "Details of social media accounts successfully added to the authenticated user's profile, typically including platform and URL for each.",
1233 "title": "Data",
1234 "type": "object"
1235 },
1236 "error": {
1237 "default": null,
1238 "description": "Error if any occurred during the execution of the action",
1239 "nullable": true,
1240 "title": "Error",
1241 "type": "string"
1242 },
1243 "successful": {
1244 "description": "Whether or not the action execution was successful or not",
1245 "title": "Successful",
1246 "type": "boolean"
1247 }
1248 },
1249 "required": ["data", "successful"],
1250 "title": "AddSocialAccountsForTheAuthenticatedUserResponseWrapper",
1251 "type": "object"
1252 },
1253 "description": "Adds one or more social media links (which must be valid, full urls for platforms supported by github) to the authenticated user's public github profile.",
1254 "tags": ["updateHint", "openWorldHint", "Social Integration", "mcpIgnore"]
1255 },
1256 {
1257 "available_versions": ["latest"],
1258 "name": "Add status check contexts",
1259 "slug": "GITHUB_ADD_STATUS_CHECK_CONTEXTS",
1260 "input_parameters": {
1261 "description": "Request model detailing the path parameters for adding status check contexts to a protected branch.\nNote: The actual contexts to add are passed in the request body and are not part of this model's explicit fields.",
1262 "properties": {
1263 "branch": {
1264 "description": "The name of the branch to which status check contexts will be added. Branch names cannot contain wildcard characters. To use wildcard characters in branch names, refer to [the GraphQL API](https://docs.github.com/graphql).",
1265 "examples": ["main", "develop"],
1266 "title": "Branch",
1267 "type": "string"
1268 },
1269 "owner": {
1270 "description": "The account owner of the repository. This name is not case sensitive.",
1271 "examples": ["octocat"],
1272 "title": "Owner",
1273 "type": "string"
1274 },
1275 "repo": {
1276 "description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
1277 "examples": ["Hello-World"],
1278 "title": "Repo",
1279 "type": "string"
1280 }
1281 },
1282 "required": ["owner", "repo", "branch"],
1283 "title": "AddStatusCheckContextsRequest",
1284 "type": "object"
1285 },
1286 "output_parameters": {
1287 "properties": {
1288 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1289 "error": {
1290 "default": null,
1291 "description": "Error if any occurred during the execution of the action",
1292 "nullable": true,
1293 "title": "Error",
1294 "type": "string"
1295 },
1296 "successful": {
1297 "description": "Whether or not the action execution was successful or not",
1298 "title": "Successful",
1299 "type": "boolean"
1300 }
1301 },
1302 "required": ["data", "successful"],
1303 "title": "AddStatusCheckContextsResponseWrapper",
1304 "type": "object"
1305 },
1306 "description": "Adds status check contexts (provided in the request body, e.g., `{\"contexts\": [\"new-context\"]}`) to a protected branch, requiring these contexts to have been previously reported.",
1307 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Repositories", "mcpIgnore"]
1308 },
1309 {
1310 "available_versions": ["latest"],
1311 "name": "Add team access restrictions",
1312 "slug": "GITHUB_ADD_TEAM_ACCESS_RESTRICTIONS",
1313 "input_parameters": {
1314 "description": "Request schema for `AddTeamAccessRestrictions`",
1315 "properties": {
1316 "branch": {
1317 "description": "The name of the branch to apply restrictions to. Wildcard characters are not supported for this field. To use wildcard characters in branch names, please consult the GitHub GraphQL API (see https://docs.github.com/graphql).",
1318 "examples": ["main", "develop", "feature/new-login"],
1319 "title": "Branch",
1320 "type": "string"
1321 },
1322 "owner": {
1323 "description": "The GitHub username or organization name that owns the repository. This value is not case-sensitive.",
1324 "examples": ["octocat", "github"],
1325 "title": "Owner",
1326 "type": "string"
1327 },
1328 "repo": {
1329 "description": "The name of the repository, without the `.git` extension. This value is not case-sensitive.",
1330 "examples": ["Spoon-Knife", "Hello-World"],
1331 "title": "Repo",
1332 "type": "string"
1333 }
1334 },
1335 "required": ["owner", "repo", "branch"],
1336 "title": "AddTeamAccessRestrictionsRequest",
1337 "type": "object"
1338 },
1339 "output_parameters": {
1340 "properties": {
1341 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1342 "error": {
1343 "default": null,
1344 "description": "Error if any occurred during the execution of the action",
1345 "nullable": true,
1346 "title": "Error",
1347 "type": "string"
1348 },
1349 "successful": {
1350 "description": "Whether or not the action execution was successful or not",
1351 "title": "Successful",
1352 "type": "boolean"
1353 }
1354 },
1355 "required": ["data", "successful"],
1356 "title": "AddTeamAccessRestrictionsResponseWrapper",
1357 "type": "object"
1358 },
1359 "description": "Overwrites the list of teams (and their child teams) granted push access to a protected branch; the list of team slugs must be provided in the http post request body.",
1360 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Repositories", "mcpIgnore"]
1361 },
1362 {
1363 "available_versions": ["latest"],
1364 "name": "Add users to codespaces access for an organization",
1365 "slug": "GITHUB_ADD_USERS_TO_CODESPACES_ACCESS_FOR_AN_ORGANIZATION",
1366 "input_parameters": {
1367 "description": "Request schema for `AddUsersToCodespacesAccessForAnOrganization`",
1368 "properties": {
1369 "org": {
1370 "description": "Organization's name (case-insensitive).",
1371 "examples": ["github", "my-organization"],
1372 "title": "Org",
1373 "type": "string"
1374 },
1375 "selected_usernames": {
1376 "description": "Usernames of organization members to be granted Codespaces access billed to the organization. These users must be members of the specified organization.",
1377 "examples": [
1378 ["octocat", "hubot"],
1379 ["another-user", "dev-user"]
1380 ],
1381 "items": { "properties": {}, "type": "string" },
1382 "title": "Selected Usernames",
1383 "type": "array"
1384 }
1385 },
1386 "required": ["org", "selected_usernames"],
1387 "title": "AddUsersToCodespacesAccessForAnOrganizationRequest",
1388 "type": "object"
1389 },
1390 "output_parameters": {
1391 "properties": {
1392 "data": {
1393 "additionalProperties": true,
1394 "description": "API response. May be empty or absent on success (e.g., HTTP 204), or contain error details on failure.",
1395 "title": "Data",
1396 "type": "object"
1397 },
1398 "error": {
1399 "default": null,
1400 "description": "Error if any occurred during the execution of the action",
1401 "nullable": true,
1402 "title": "Error",
1403 "type": "string"
1404 },
1405 "successful": {
1406 "description": "Whether or not the action execution was successful or not",
1407 "title": "Successful",
1408 "type": "boolean"
1409 }
1410 },
1411 "required": ["data", "successful"],
1412 "title": "AddUsersToCodespacesAccessForAnOrganizationResponseWrapper",
1413 "type": "object"
1414 },
1415 "description": "Sets or replaces the list of organization members granted codespaces access billed to the organization; ensure the organization's billing settings allow access for selected members.",
1416 "tags": ["updateHint", "openWorldHint", "Code Spaces", "mcpIgnore"]
1417 },
1418 {
1419 "available_versions": ["latest"],
1420 "name": "Add user access restrictions",
1421 "slug": "GITHUB_ADD_USER_ACCESS_RESTRICTIONS",
1422 "input_parameters": {
1423 "description": "Path parameters for adding user access restrictions to a protected branch. The list of usernames must be provided in the request body as a JSON array (e.g., `[\"username1\"]`); an empty array `[]` removes all user restrictions.",
1424 "properties": {
1425 "branch": {
1426 "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, refer to the GitHub GraphQL API documentation.",
1427 "examples": ["main", "develop"],
1428 "title": "Branch",
1429 "type": "string"
1430 },
1431 "owner": {
1432 "description": "The account owner of the repository. This name is not case-sensitive.",
1433 "examples": ["octocat"],
1434 "title": "Owner",
1435 "type": "string"
1436 },
1437 "repo": {
1438 "description": "The name of the repository, without the `.git` extension. This name is not case-sensitive.",
1439 "examples": ["Spoon-Knife"],
1440 "title": "Repo",
1441 "type": "string"
1442 }
1443 },
1444 "required": ["owner", "repo", "branch"],
1445 "title": "AddUserAccessRestrictionsRequest",
1446 "type": "object"
1447 },
1448 "output_parameters": {
1449 "properties": {
1450 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1451 "error": {
1452 "default": null,
1453 "description": "Error if any occurred during the execution of the action",
1454 "nullable": true,
1455 "title": "Error",
1456 "type": "string"
1457 },
1458 "successful": {
1459 "description": "Whether or not the action execution was successful or not",
1460 "title": "Successful",
1461 "type": "boolean"
1462 }
1463 },
1464 "required": ["data", "successful"],
1465 "title": "AddUserAccessRestrictionsResponseWrapper",
1466 "type": "object"
1467 },
1468 "description": "Sets/replaces list of users allowed to push to a protected branch; usernames (e.g., `[\"user1\"]`) must be a json array in request body (not schema parameters), an empty array `[]` removes all restrictions.",
1469 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Repositories", "mcpIgnore"]
1470 },
1471 {
1472 "available_versions": ["latest"],
1473 "name": "Approve a workflow run for a fork pull request",
1474 "slug": "GITHUB_APPROVE_A_WORKFLOW_RUN_FOR_A_FORK_PULL_REQUEST",
1475 "input_parameters": {
1476 "description": "Request schema for `ApproveAWorkflowRunForAForkPullRequest`",
1477 "properties": {
1478 "owner": {
1479 "description": "The account owner of the repository. The name is not case sensitive.",
1480 "examples": ["octocat"],
1481 "title": "Owner",
1482 "type": "string"
1483 },
1484 "repo": {
1485 "description": "The name of the repository without the `.git` extension. The name is not case sensitive. ",
1486 "examples": ["Hello-World"],
1487 "title": "Repo",
1488 "type": "string"
1489 },
1490 "run_id": {
1491 "description": "The unique identifier of the workflow run requiring approval.",
1492 "examples": [12345],
1493 "title": "Run Id",
1494 "type": "integer"
1495 }
1496 },
1497 "required": ["owner", "repo", "run_id"],
1498 "title": "ApproveAWorkflowRunForAForkPullRequestRequest",
1499 "type": "object"
1500 },
1501 "output_parameters": {
1502 "properties": {
1503 "data": {
1504 "additionalProperties": true,
1505 "description": "An empty object indicating success.",
1506 "title": "Data",
1507 "type": "object"
1508 },
1509 "error": {
1510 "default": null,
1511 "description": "Error if any occurred during the execution of the action",
1512 "nullable": true,
1513 "title": "Error",
1514 "type": "string"
1515 },
1516 "successful": {
1517 "description": "Whether or not the action execution was successful or not",
1518 "title": "Successful",
1519 "type": "boolean"
1520 }
1521 },
1522 "required": ["data", "successful"],
1523 "title": "ApproveAWorkflowRunForAForkPullRequestResponseWrapper",
1524 "type": "object"
1525 },
1526 "description": "Approves a workflow run from a forked repository's pull request; call this when such a run requires manual approval due to workflow configuration.",
1527 "tags": ["idempotentHint", "updateHint", "openWorldHint", "important", "Workflows"]
1528 },
1529 {
1530 "available_versions": ["latest"],
1531 "name": "Assign an organization role to a team",
1532 "slug": "GITHUB_ASSIGN_AN_ORGANIZATION_ROLE_TO_A_TEAM",
1533 "input_parameters": {
1534 "description": "Request schema for `AssignAnOrganizationRoleToATeam`",
1535 "properties": {
1536 "org": {
1537 "description": "The name of the GitHub organization. This field is case-insensitive.",
1538 "examples": ["octo-org"],
1539 "title": "Org",
1540 "type": "string"
1541 },
1542 "role_id": {
1543 "description": "Unique identifier of the organization role to assign to the team (obtainable by listing organization roles).",
1544 "examples": [123, 456],
1545 "title": "Role Id",
1546 "type": "integer"
1547 },
1548 "team_slug": {
1549 "description": "The slug (URL-friendly version) of the team's name.",
1550 "examples": ["justice-league"],
1551 "title": "Team Slug",
1552 "type": "string"
1553 }
1554 },
1555 "required": ["org", "team_slug", "role_id"],
1556 "title": "AssignAnOrganizationRoleToATeamRequest",
1557 "type": "object"
1558 },
1559 "output_parameters": {
1560 "properties": {
1561 "data": {
1562 "additionalProperties": true,
1563 "description": "An empty dictionary if the role was assigned successfully. GitHub API returns a 204 No Content status on success.",
1564 "title": "Data",
1565 "type": "object"
1566 },
1567 "error": {
1568 "default": null,
1569 "description": "Error if any occurred during the execution of the action",
1570 "nullable": true,
1571 "title": "Error",
1572 "type": "string"
1573 },
1574 "successful": {
1575 "description": "Whether or not the action execution was successful or not",
1576 "title": "Successful",
1577 "type": "boolean"
1578 }
1579 },
1580 "required": ["data", "successful"],
1581 "title": "AssignAnOrganizationRoleToATeamResponseWrapper",
1582 "type": "object"
1583 },
1584 "description": "Assigns an existing organization-level role (identified by `role id`) to a team (identified by `team slug`) within a github organization (`org`), provided the organization, team, and role already exist.",
1585 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
1586 },
1587 {
1588 "available_versions": ["latest"],
1589 "name": "Assign an organization role to a user",
1590 "slug": "GITHUB_ASSIGN_AN_ORGANIZATION_ROLE_TO_A_USER",
1591 "input_parameters": {
1592 "description": "Request schema for `AssignAnOrganizationRoleToAUser`",
1593 "properties": {
1594 "org": {
1595 "description": "The organization's name. This is not case-sensitive.",
1596 "examples": ["github", "acme-corp"],
1597 "title": "Org",
1598 "type": "string"
1599 },
1600 "role_id": {
1601 "description": "The unique integer identifier for the organization role. This ID can be obtained by listing the organization's roles.",
1602 "examples": ["1", "42", "101"],
1603 "title": "Role Id",
1604 "type": "integer"
1605 },
1606 "username": {
1607 "description": "The GitHub username of the user to whom the role will be assigned.",
1608 "examples": ["octocat", "githubuser123"],
1609 "title": "Username",
1610 "type": "string"
1611 }
1612 },
1613 "required": ["org", "username", "role_id"],
1614 "title": "AssignAnOrganizationRoleToAUserRequest",
1615 "type": "object"
1616 },
1617 "output_parameters": {
1618 "properties": {
1619 "data": {
1620 "additionalProperties": true,
1621 "description": "A dictionary that is typically empty upon successful role assignment, as the GitHub API returns a 204 No Content status for this operation.",
1622 "title": "Data",
1623 "type": "object"
1624 },
1625 "error": {
1626 "default": null,
1627 "description": "Error if any occurred during the execution of the action",
1628 "nullable": true,
1629 "title": "Error",
1630 "type": "string"
1631 },
1632 "successful": {
1633 "description": "Whether or not the action execution was successful or not",
1634 "title": "Successful",
1635 "type": "boolean"
1636 }
1637 },
1638 "required": ["data", "successful"],
1639 "title": "AssignAnOrganizationRoleToAUserResponseWrapper",
1640 "type": "object"
1641 },
1642 "description": "Assigns a specific organization role to a user who is a member or an outside collaborator in a github organization, using a valid role id.",
1643 "tags": ["idempotentHint", "updateHint", "openWorldHint", "Organizations", "mcpIgnore"]
1644 },
1645 {
1646 "available_versions": ["latest"],
1647 "name": "Authuserdockerconflictpackageslist",
1648 "slug": "GITHUB_AUTH_USER_DOCKER_CONFLICT_PACKAGES_LIST",
1649 "input_parameters": {
1650 "description": "Request model; no specific parameters are required.",
1651 "properties": {},
1652 "title": "AuthUserDockerConflictPackagesListRequest",
1653 "type": "object"
1654 },
1655 "output_parameters": {
1656 "properties": {
1657 "data": {
1658 "additionalProperties": true,
1659 "description": "List of the authenticated user's Docker packages that experienced conflicts during migration, including details for each.",
1660 "title": "Data",
1661 "type": "object"
1662 },
1663 "error": {
1664 "default": null,
1665 "description": "Error if any occurred during the execution of the action",
1666 "nullable": true,
1667 "title": "Error",
1668 "type": "string"
1669 },
1670 "successful": {
1671 "description": "Whether or not the action execution was successful or not",
1672 "title": "Successful",
1673 "type": "boolean"
1674 }
1675 },
1676 "required": ["data", "successful"],
1677 "title": "AuthUserDockerConflictPackagesListResponseWrapper",
1678 "type": "object"
1679 },
1680 "description": "Lists docker packages for the authenticated user that encountered conflicts during the docker migration process.",
1681 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Repositories", "mcpIgnore"]
1682 },
1683 {
1684 "available_versions": ["latest"],
1685 "name": "Block a user",
1686 "slug": "GITHUB_BLOCK_A_USER",
1687 "input_parameters": {
1688 "description": "Identifies the GitHub user to block by their username.",
1689 "properties": {
1690 "username": {
1691 "description": "Case-sensitive GitHub username of the user to block.",
1692 "examples": ["octocat", "devuser123"],
1693 "title": "Username",
1694 "type": "string"
1695 }
1696 },
1697 "required": ["username"],
1698 "title": "BlockAUserRequest",
1699 "type": "object"
1700 },
1701 "output_parameters": {
1702 "properties": {
1703 "data": {
1704 "additionalProperties": true,
1705 "description": "Response data from the GitHub API; typically empty on success (HTTP 204 No Content), but populated for other response codes.",
1706 "title": "Data",
1707 "type": "object"
1708 },
1709 "error": {
1710 "default": null,
1711 "description": "Error if any occurred during the execution of the action",
1712 "nullable": true,
1713 "title": "Error",
1714 "type": "string"
1715 },
1716 "successful": {
1717 "description": "Whether or not the action execution was successful or not",
1718 "title": "Successful",
1719 "type": "boolean"
1720 }
1721 },
1722 "required": ["successful"],
1723 "title": "BlockAUserResponseWrapper",
1724 "type": "object"
1725 },
1726 "description": "Blocks an existing individual github user (not an organization or your own account), preventing them from interacting with your account and repositories.",
1727 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "Users", "mcpIgnore"]
1728 },
1729 {
1730 "available_versions": ["latest"],
1731 "name": "Block a user from an organization",
1732 "slug": "GITHUB_BLOCK_A_USER_FROM_AN_ORGANIZATION",
1733 "input_parameters": {
1734 "description": "Input data for blocking a user from an organization.",
1735 "properties": {
1736 "org": {
1737 "description": "The case-insensitive name of the GitHub organization.",
1738 "examples": ["github", "google"],
1739 "title": "Org",
1740 "type": "string"
1741 },
1742 "username": {
1743 "description": "The GitHub username (handle) of the account to block.",
1744 "examples": ["octocat", "someuser"],
1745 "title": "Username",
1746 "type": "string"
1747 }
1748 },
1749 "required": ["org", "username"],
1750 "title": "BlockAUserFromAnOrganizationRequest",
1751 "type": "object"
1752 },
1753 "output_parameters": {
1754 "properties": {
1755 "data": {
1756 "additionalProperties": true,
1757 "description": "A dictionary containing the response data from the API. For a successful block operation (HTTP 204 No Content), this dictionary is typically empty.",
1758 "title": "Data",
1759 "type": "object"
1760 },
1761 "error": {
1762 "default": null,
1763 "description": "Error if any occurred during the execution of the action",
1764 "nullable": true,
1765 "title": "Error",
1766 "type": "string"
1767 },
1768 "successful": {
1769 "description": "Whether or not the action execution was successful or not",
1770 "title": "Successful",
1771 "type": "boolean"
1772 }
1773 },
1774 "required": ["data", "successful"],
1775 "title": "BlockAUserFromAnOrganizationResponseWrapper",
1776 "type": "object"
1777 },
1778 "description": "Blocks an existing github user from an existing organization, preventing their contributions, collaboration, and forking of the organization's repositories.",
1779 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "Organizations", "mcpIgnore"]
1780 },
1781 {
1782 "available_versions": ["latest"],
1783 "name": "Cancel a GitHub Pages deployment",
1784 "slug": "GITHUB_CANCEL_A_GITHUB_PAGES_DEPLOYMENT",
1785 "input_parameters": {
1786 "description": "Request schema for `CancelAGithubPagesDeployment`",
1787 "properties": {
1788 "owner": {
1789 "description": "Username or organization that owns the repository. Not case-sensitive.",
1790 "examples": ["octocat"],
1791 "title": "Owner",
1792 "type": "string"
1793 },
1794 "pages_deployment_id": {
1795 "description": "Unique numerical ID of the GitHub Pages deployment (not the commit SHA).",
1796 "examples": [123456789],
1797 "title": "Pages Deployment Id",
1798 "type": "integer"
1799 },
1800 "repo": {
1801 "description": "Repository name, excluding the `.git` extension. Not case-sensitive.",
1802 "examples": ["Hello-World"],
1803 "title": "Repo",
1804 "type": "string"
1805 }
1806 },
1807 "required": ["owner", "repo", "pages_deployment_id"],
1808 "title": "CancelAGithubPagesDeploymentRequest",
1809 "type": "object"
1810 },
1811 "output_parameters": {
1812 "properties": {
1813 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1814 "error": {
1815 "default": null,
1816 "description": "Error if any occurred during the execution of the action",
1817 "nullable": true,
1818 "title": "Error",
1819 "type": "string"
1820 },
1821 "successful": {
1822 "description": "Whether or not the action execution was successful or not",
1823 "title": "Successful",
1824 "type": "boolean"
1825 }
1826 },
1827 "required": ["data", "successful"],
1828 "title": "CancelAGithubPagesDeploymentResponseWrapper",
1829 "type": "object"
1830 },
1831 "description": "Cancels an existing, ongoing or queued github pages deployment for a repository using its `pages deployment id`.",
1832 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "Deployments", "mcpIgnore"]
1833 },
1834 {
1835 "available_versions": ["latest"],
1836 "name": "Cancel a workflow run",
1837 "slug": "GITHUB_CANCEL_A_WORKFLOW_RUN",
1838 "input_parameters": {
1839 "description": "Request schema for `CancelAWorkflowRun`",
1840 "properties": {
1841 "owner": {
1842 "description": "The account owner of the repository (not case-sensitive).",
1843 "examples": ["octocat", "github"],
1844 "title": "Owner",
1845 "type": "string"
1846 },
1847 "repo": {
1848 "description": "The name of the repository, without the `.git` extension (not case-sensitive).",
1849 "examples": ["Hello-World", "linguist"],
1850 "title": "Repo",
1851 "type": "string"
1852 },
1853 "run_id": {
1854 "description": "Unique identifier of the workflow run.",
1855 "examples": [123456789],
1856 "title": "Run Id",
1857 "type": "integer"
1858 }
1859 },
1860 "required": ["owner", "repo", "run_id"],
1861 "title": "CancelAWorkflowRunRequest",
1862 "type": "object"
1863 },
1864 "output_parameters": {
1865 "properties": {
1866 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1867 "error": {
1868 "default": null,
1869 "description": "Error if any occurred during the execution of the action",
1870 "nullable": true,
1871 "title": "Error",
1872 "type": "string"
1873 },
1874 "successful": {
1875 "description": "Whether or not the action execution was successful or not",
1876 "title": "Successful",
1877 "type": "boolean"
1878 }
1879 },
1880 "required": ["data", "successful"],
1881 "title": "CancelAWorkflowRunResponseWrapper",
1882 "type": "object"
1883 },
1884 "description": "Cancels a workflow run in a github repository if it is in a cancellable state (e.g., 'in progress' or 'queued').",
1885 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "Workflows", "mcpIgnore"]
1886 },
1887 {
1888 "available_versions": ["latest"],
1889 "name": "Check a token",
1890 "slug": "GITHUB_CHECK_A_TOKEN",
1891 "input_parameters": {
1892 "description": "Request schema for validating a GitHub App or OAuth token.",
1893 "properties": {
1894 "access_token": {
1895 "description": "The OAuth or GitHub App access token that needs to be checked for validity.",
1896 "examples": ["gho_A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6Q7r8S9t0"],
1897 "title": "Access Token",
1898 "type": "string"
1899 },
1900 "client_id": {
1901 "description": "The unique client ID of the GitHub App for which the token was issued.",
1902 "examples": ["Iv1.1234567890abcdef"],
1903 "title": "Client Id",
1904 "type": "string"
1905 }
1906 },
1907 "required": ["client_id", "access_token"],
1908 "title": "CheckATokenRequest",
1909 "type": "object"
1910 },
1911 "output_parameters": {
1912 "properties": {
1913 "data": {
1914 "additionalProperties": true,
1915 "description": "A dictionary containing details of the validated token if it is valid. Key information includes `id`, `url`, `app` (details of the GitHub App), `token` (the token string), `user` (if a user token), `scopes`, `permissions`, `created_at`, `updated_at`, and `expires_at` (if applicable).",
1916 "title": "Data",
1917 "type": "object"
1918 },
1919 "error": {
1920 "default": null,
1921 "description": "Error if any occurred during the execution of the action",
1922 "nullable": true,
1923 "title": "Error",
1924 "type": "string"
1925 },
1926 "successful": {
1927 "description": "Whether or not the action execution was successful or not",
1928 "title": "Successful",
1929 "type": "boolean"
1930 }
1931 },
1932 "required": ["data", "successful"],
1933 "title": "CheckATokenResponseWrapper",
1934 "type": "object"
1935 },
1936 "description": "Checks if a github app or oauth access token is valid for the specified client id and retrieves its details, typically to verify its active status and grants.",
1937 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Security", "mcpIgnore"]
1938 },
1939 {
1940 "available_versions": ["latest"],
1941 "name": "Check if a gist is starred",
1942 "slug": "GITHUB_CHECK_IF_A_GIST_IS_STARRED",
1943 "input_parameters": {
1944 "description": "Request schema for `CheckIfAGistIsStarred`",
1945 "properties": {
1946 "gist_id": {
1947 "description": "The ID of the Gist to check.",
1948 "examples": ["6104628abc0786a41abb273430ac0590"],
1949 "title": "Gist Id",
1950 "type": "string"
1951 }
1952 },
1953 "required": ["gist_id"],
1954 "title": "CheckIfAGistIsStarredRequest",
1955 "type": "object"
1956 },
1957 "output_parameters": {
1958 "properties": {
1959 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
1960 "error": {
1961 "default": null,
1962 "description": "Error if any occurred during the execution of the action",
1963 "nullable": true,
1964 "title": "Error",
1965 "type": "string"
1966 },
1967 "successful": {
1968 "description": "Whether or not the action execution was successful or not",
1969 "title": "Successful",
1970 "type": "boolean"
1971 }
1972 },
1973 "required": ["data", "successful"],
1974 "title": "CheckIfAGistIsStarredResponseWrapper",
1975 "type": "object"
1976 },
1977 "description": "Checks if a gist, identified by `gist id`, is starred by the authenticated user, returning an empty response (204) if starred, or a 404 error if not starred or not found.",
1978 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Gists", "mcpIgnore"]
1979 },
1980 {
1981 "available_versions": ["latest"],
1982 "name": "Check if person is followed by authenticated user",
1983 "slug": "GITHUB_CHECK_IF_A_PERSON_IS_FOLLOWED_BY_THE_AUTHENTICATED_USER",
1984 "input_parameters": {
1985 "description": "Input model for the action that checks if the authenticated user follows another GitHub user.",
1986 "properties": {
1987 "username": {
1988 "description": "The GitHub username (e.g., 'octocat') of the person to check. This is the user's handle on GitHub.",
1989 "examples": ["octocat", "torvalds"],
1990 "title": "Username",
1991 "type": "string"
1992 }
1993 },
1994 "required": ["username"],
1995 "title": "CheckIfAPersonIsFollowedByTheAuthenticatedUserRequest",
1996 "type": "object"
1997 },
1998 "output_parameters": {
1999 "properties": {
2000 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
2001 "error": {
2002 "default": null,
2003 "description": "Error if any occurred during the execution of the action",
2004 "nullable": true,
2005 "title": "Error",
2006 "type": "string"
2007 },
2008 "successful": {
2009 "description": "Whether or not the action execution was successful or not",
2010 "title": "Successful",
2011 "type": "boolean"
2012 }
2013 },
2014 "required": ["data", "successful"],
2015 "title": "CheckIfAPersonIsFollowedByTheAuthenticatedUserResponseWrapper",
2016 "type": "object"
2017 },
2018 "description": "Checks if the authenticated github user follows a target github user; an http 204 status indicates the user is followed, while an http 404 status indicates the user is not followed or the target user does not exist.",
2019 "tags": ["readOnlyHint", "openWorldHint", "User Management", "mcpIgnore"]
2020 },
2021 {
2022 "available_versions": ["latest"],
2023 "name": "Check if pull request merged",
2024 "slug": "GITHUB_CHECK_IF_A_PULL_REQUEST_HAS_BEEN_MERGED",
2025 "input_parameters": {
2026 "description": "Request schema for `CheckIfAPullRequestHasBeenMerged`",
2027 "properties": {
2028 "owner": {
2029 "description": "The account owner of the repository (not case sensitive).",
2030 "examples": ["octocat"],
2031 "title": "Owner",
2032 "type": "string"
2033 },
2034 "pull_number": {
2035 "description": "The number that identifies the pull request.",
2036 "examples": ["1347"],
2037 "title": "Pull Number",
2038 "type": "integer"
2039 },
2040 "repo": {
2041 "description": "The name of the repository, without the `.git` extension (not case sensitive).",
2042 "examples": ["Spoon-Knife"],
2043 "title": "Repo",
2044 "type": "string"
2045 }
2046 },
2047 "required": ["owner", "repo", "pull_number"],
2048 "title": "CheckIfAPullRequestHasBeenMergedRequest",
2049 "type": "object"
2050 },
2051 "output_parameters": {
2052 "properties": {
2053 "data": {
2054 "additionalProperties": true,
2055 "description": "API response data. Merge status is indicated by HTTP status: 204 (merged, empty body) or 404 (not merged/found, body may contain error details).",
2056 "title": "Data",
2057 "type": "object"
2058 },
2059 "error": {
2060 "default": null,
2061 "description": "Error if any occurred during the execution of the action",
2062 "nullable": true,
2063 "title": "Error",
2064 "type": "string"
2065 },
2066 "successful": {
2067 "description": "Whether or not the action execution was successful or not",
2068 "title": "Successful",
2069 "type": "boolean"
2070 }
2071 },
2072 "required": ["data", "successful"],
2073 "title": "CheckIfAPullRequestHasBeenMergedResponseWrapper",
2074 "type": "object"
2075 },
2076 "description": "Checks if a specified github pull request has been merged, indicated by a 204 http status (merged) or 404 (not merged/found).",
2077 "tags": ["readOnlyHint", "openWorldHint", "Pull Requests", "mcpIgnore"]
2078 },
2079 {
2080 "available_versions": ["latest"],
2081 "name": "Check if repo starred by auth user",
2082 "slug": "GITHUB_CHECK_IF_A_REPOSITORY_IS_STARRED_BY_THE_AUTHENTICATED_USER",
2083 "input_parameters": {
2084 "description": "Request model for specifying the repository to check for a star by the authenticated user.",
2085 "properties": {
2086 "owner": {
2087 "description": "The account owner of the repository (e.g., a user or organization). This name is not case sensitive.",
2088 "examples": ["octocat", "example-org"],
2089 "title": "Owner",
2090 "type": "string"
2091 },
2092 "repo": {
2093 "description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
2094 "examples": ["Spoon-Knife", "my-project"],
2095 "title": "Repo",
2096 "type": "string"
2097 }
2098 },
2099 "required": ["owner", "repo"],
2100 "title": "CheckIfARepositoryIsStarredByTheAuthenticatedUserRequest",
2101 "type": "object"
2102 },
2103 "output_parameters": {
2104 "properties": {
2105 "data": {
2106 "additionalProperties": true,
2107 "description": "Empty dictionary if the repository is starred by the authenticated user (signified by an HTTP 204 No Content from GitHub API). If not starred or if the repository doesn't exist, an API error (e.g., HTTP 404) is raised, and this response is not populated.",
2108 "title": "Data",
2109 "type": "object"
2110 },
2111 "error": {
2112 "default": null,
2113 "description": "Error if any occurred during the execution of the action",
2114 "nullable": true,
2115 "title": "Error",
2116 "type": "string"
2117 },
2118 "successful": {
2119 "description": "Whether or not the action execution was successful or not",
2120 "title": "Successful",
2121 "type": "boolean"
2122 }
2123 },
2124 "required": ["data", "successful"],
2125 "title": "CheckIfARepositoryIsStarredByTheAuthenticatedUserResponseWrapper",
2126 "type": "object"
2127 },
2128 "description": "Use to determine if the authenticated user has starred a specific github repository, which is confirmed by an http 204 status (resulting in an empty dictionary in the response data); the action fails (e.g., http 404) if the repository is not starred or does not exist.",
2129 "tags": ["readOnlyHint", "openWorldHint", "Repository Management", "mcpIgnore"]
2130 },
2131 {
2132 "available_versions": ["latest"],
2133 "name": "Check if a user can be assigned",
2134 "slug": "GITHUB_CHECK_IF_A_USER_CAN_BE_ASSIGNED",
2135 "input_parameters": {
2136 "description": "Request schema for checking if a user can be assigned to issues in a repository.",
2137 "properties": {
2138 "assignee": {
2139 "description": "The GitHub username of the user to check for assignability. This name is not case sensitive.",
2140 "examples": ["hubot", "monalisa"],
2141 "title": "Assignee",
2142 "type": "string"
2143 },
2144 "owner": {
2145 "description": "The account owner of the repository (e.g., a GitHub username or organization name). This name is not case sensitive.",
2146 "examples": ["octocat", "my-organization"],
2147 "title": "Owner",
2148 "type": "string"
2149 },
2150 "repo": {
2151 "description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
2152 "examples": ["Spoon-Knife", "my-awesome-project"],
2153 "title": "Repo",
2154 "type": "string"
2155 }
2156 },
2157 "required": ["owner", "repo", "assignee"],
2158 "title": "CheckIfAUserCanBeAssignedRequest",
2159 "type": "object"
2160 },
2161 "output_parameters": {
2162 "properties": {
2163 "data": {
2164 "additionalProperties": true,
2165 "description": "API response data. Typically empty if the user can be assigned (HTTP 204 No Content).",
2166 "title": "Data",
2167 "type": "object"
2168 },
2169 "error": {
2170 "default": null,
2171 "description": "Error if any occurred during the execution of the action",
2172 "nullable": true,
2173 "title": "Error",
2174 "type": "string"
2175 },
2176 "successful": {
2177 "description": "Whether or not the action execution was successful or not",
2178 "title": "Successful",
2179 "type": "boolean"
2180 }
2181 },
2182 "required": ["data", "successful"],
2183 "title": "CheckIfAUserCanBeAssignedResponseWrapper",
2184 "type": "object"
2185 },
2186 "description": "Verifies if a github user can be assigned to issues in a repository; assignability is confirmed by an http 204 (no content) response, resulting in an empty 'data' field in the response.",
2187 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Issues", "mcpIgnore"]
2188 },
2189 {
2190 "available_versions": ["latest"],
2191 "name": "Check if a user can be assigned to an issue",
2192 "slug": "GITHUB_CHECK_IF_A_USER_CAN_BE_ASSIGNED_TO_A_ISSUE",
2193 "input_parameters": {
2194 "description": "Request schema for `CheckIfAUserCanBeAssignedToAIssue`",
2195 "properties": {
2196 "assignee": {
2197 "description": "The GitHub username of the user to check for assignment permissions.",
2198 "examples": ["hubot"],
2199 "title": "Assignee",
2200 "type": "string"
2201 },
2202 "issue_number": {
2203 "description": "The unique number identifying the issue within the repository.",
2204 "examples": ["1347"],
2205 "title": "Issue Number",
2206 "type": "integer"
2207 },
2208 "owner": {
2209 "description": "The username of the account owning the repository. This field is not case-sensitive.",
2210 "examples": ["octocat"],
2211 "title": "Owner",
2212 "type": "string"
2213 },
2214 "repo": {
2215 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
2216 "examples": ["Spoon-Knife"],
2217 "title": "Repo",
2218 "type": "string"
2219 }
2220 },
2221 "required": ["owner", "repo", "issue_number", "assignee"],
2222 "title": "CheckIfAUserCanBeAssignedToAIssueRequest",
2223 "type": "object"
2224 },
2225 "output_parameters": {
2226 "properties": {
2227 "data": {
2228 "additionalProperties": true,
2229 "description": "Empty if the user can be assigned; otherwise, contains GitHub error details if the user cannot be assigned or if the issue/repository is not found.",
2230 "title": "Data",
2231 "type": "object"
2232 },
2233 "error": {
2234 "default": null,
2235 "description": "Error if any occurred during the execution of the action",
2236 "nullable": true,
2237 "title": "Error",
2238 "type": "string"
2239 },
2240 "successful": {
2241 "description": "Whether or not the action execution was successful or not",
2242 "title": "Successful",
2243 "type": "boolean"
2244 }
2245 },
2246 "required": ["data", "successful"],
2247 "title": "CheckIfAUserCanBeAssignedToAIssueResponseWrapper",
2248 "type": "object"
2249 },
2250 "description": "Checks if a specified github user can be assigned to a given issue within a repository.",
2251 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Issues", "mcpIgnore"]
2252 },
2253 {
2254 "available_versions": ["latest"],
2255 "name": "Check if a user follows another user",
2256 "slug": "GITHUB_CHECK_IF_A_USER_FOLLOWS_ANOTHER_USER",
2257 "input_parameters": {
2258 "description": "Request schema for checking if one GitHub user follows another.",
2259 "properties": {
2260 "target_user": {
2261 "description": "The GitHub username of the user to verify if they are followed by the `username`.",
2262 "examples": ["mercury-tools-bot", "github"],
2263 "title": "Target User",
2264 "type": "string"
2265 },
2266 "username": {
2267 "description": "The GitHub username of the user to check.",
2268 "examples": ["octocat", "torvalds"],
2269 "title": "Username",
2270 "type": "string"
2271 }
2272 },
2273 "required": ["username", "target_user"],
2274 "title": "CheckIfAUserFollowsAnotherUserRequest",
2275 "type": "object"
2276 },
2277 "output_parameters": {
2278 "properties": {
2279 "data": {
2280 "additionalProperties": true,
2281 "description": "An empty dictionary. The follow status is determined by the HTTP response code (204 for following, 404 for not following), not the content of this field.",
2282 "title": "Data",
2283 "type": "object"
2284 },
2285 "error": {
2286 "default": null,
2287 "description": "Error if any occurred during the execution of the action",
2288 "nullable": true,
2289 "title": "Error",
2290 "type": "string"
2291 },
2292 "successful": {
2293 "description": "Whether or not the action execution was successful or not",
2294 "title": "Successful",
2295 "type": "boolean"
2296 }
2297 },
2298 "required": ["data", "successful"],
2299 "title": "CheckIfAUserFollowsAnotherUserResponseWrapper",
2300 "type": "object"
2301 },
2302 "description": "Checks if a github user `username` follows `target user`; returns a 204 http status if true, 404 if not or if users are invalid.",
2303 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Users", "mcpIgnore"]
2304 },
2305 {
2306 "available_versions": ["latest"],
2307 "name": "Check if a user is a repository collaborator",
2308 "slug": "GITHUB_CHECK_IF_A_USER_IS_A_REPOSITORY_COLLABORATOR",
2309 "input_parameters": {
2310 "description": "Request schema for `CheckIfAUserIsARepositoryCollaborator`",
2311 "properties": {
2312 "owner": {
2313 "description": "The account owner of the repository, typically a GitHub username or an organization name. This name is not case sensitive.",
2314 "examples": ["octocat", "my-github-org"],
2315 "title": "Owner",
2316 "type": "string"
2317 },
2318 "repo": {
2319 "description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
2320 "examples": ["Spoon-Knife", "my-project-repo"],
2321 "title": "Repo",
2322 "type": "string"
2323 },
2324 "username": {
2325 "description": "The GitHub username of the user whose collaborator status is being checked. This name is not case sensitive.",
2326 "examples": ["gh-user123", "another-dev"],
2327 "title": "Username",
2328 "type": "string"
2329 }
2330 },
2331 "required": ["owner", "repo", "username"],
2332 "title": "CheckIfAUserIsARepositoryCollaboratorRequest",
2333 "type": "object"
2334 },
2335 "output_parameters": {
2336 "properties": {
2337 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
2338 "error": {
2339 "default": null,
2340 "description": "Error if any occurred during the execution of the action",
2341 "nullable": true,
2342 "title": "Error",
2343 "type": "string"
2344 },
2345 "successful": {
2346 "description": "Whether or not the action execution was successful or not",
2347 "title": "Successful",
2348 "type": "boolean"
2349 }
2350 },
2351 "required": ["data", "successful"],
2352 "title": "CheckIfAUserIsARepositoryCollaboratorResponseWrapper",
2353 "type": "object"
2354 },
2355 "description": "Checks if a user is a collaborator on a specified github repository, returning a 204 status if they are, or a 404 status if they are not or if the repository/user does not exist.",
2356 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Repositories", "mcpIgnore"]
2357 },
2358 {
2359 "available_versions": ["latest"],
2360 "name": "Check if a user is blocked by an organization",
2361 "slug": "GITHUB_CHECK_IF_A_USER_IS_BLOCKED_BY_AN_ORGANIZATION",
2362 "input_parameters": {
2363 "description": "Request schema for `CheckIfAUserIsBlockedByAnOrganization`",
2364 "properties": {
2365 "org": {
2366 "description": "The organization's GitHub name. This name is not case-sensitive.",
2367 "examples": ["github", "octo-org"],
2368 "title": "Org",
2369 "type": "string"
2370 },
2371 "username": {
2372 "description": "The GitHub username of the user to check.",
2373 "examples": ["octocat", "mona-lisa"],
2374 "title": "Username",
2375 "type": "string"
2376 }
2377 },
2378 "required": ["org", "username"],
2379 "title": "CheckIfAUserIsBlockedByAnOrganizationRequest",
2380 "type": "object"
2381 },
2382 "output_parameters": {
2383 "properties": {
2384 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
2385 "error": {
2386 "default": null,
2387 "description": "Error if any occurred during the execution of the action",
2388 "nullable": true,
2389 "title": "Error",
2390 "type": "string"
2391 },
2392 "successful": {
2393 "description": "Whether or not the action execution was successful or not",
2394 "title": "Successful",
2395 "type": "boolean"
2396 }
2397 },
2398 "required": ["data", "successful"],
2399 "title": "CheckIfAUserIsBlockedByAnOrganizationResponseWrapper",
2400 "type": "object"
2401 },
2402 "description": "Checks if a github user is blocked by an organization; a successful response (204 no content) indicates the user is blocked, while a 404 not found error indicates the user is not blocked.",
2403 "tags": ["readOnlyHint", "openWorldHint", "User Management", "mcpIgnore"]
2404 },
2405 {
2406 "available_versions": ["latest"],
2407 "name": "Check if a user is blocked by the authenticated user",
2408 "slug": "GITHUB_CHECK_IF_A_USER_IS_BLOCKED_BY_THE_AUTHENTICATED_USER",
2409 "input_parameters": {
2410 "description": "Request to check if a user is blocked by the authenticated user.",
2411 "properties": {
2412 "username": {
2413 "description": "The GitHub username (handle) of the user.",
2414 "examples": ["octocat", "torvalds"],
2415 "title": "Username",
2416 "type": "string"
2417 }
2418 },
2419 "required": ["username"],
2420 "title": "CheckIfAUserIsBlockedByTheAuthenticatedUserRequest",
2421 "type": "object"
2422 },
2423 "output_parameters": {
2424 "properties": {
2425 "data": {
2426 "additionalProperties": true,
2427 "description": "An empty dictionary, returned when the API signals the user is blocked (204 No Content). This model is not used if the user is not blocked (API returns 404 Not Found).",
2428 "title": "Data",
2429 "type": "object"
2430 },
2431 "error": {
2432 "default": null,
2433 "description": "Error if any occurred during the execution of the action",
2434 "nullable": true,
2435 "title": "Error",
2436 "type": "string"
2437 },
2438 "successful": {
2439 "description": "Whether or not the action execution was successful or not",
2440 "title": "Successful",
2441 "type": "boolean"
2442 }
2443 },
2444 "required": ["data", "successful"],
2445 "title": "CheckIfAUserIsBlockedByTheAuthenticatedUserResponseWrapper",
2446 "type": "object"
2447 },
2448 "description": "Checks if the specified github user is blocked by the authenticated user; a 204 no content response indicates the user is blocked, while a 404 not found indicates they are not.",
2449 "tags": ["readOnlyHint", "openWorldHint", "User Management", "mcpIgnore"]
2450 },
2451 {
2452 "available_versions": ["latest"],
2453 "name": "Check private vulnerability reporting status",
2454 "slug": "GITHUB_CHECK_PRIVATE_VULNERABILITY_REPORTING_STATUS",
2455 "input_parameters": {
2456 "description": "Request schema for `CheckPrivateVulnerabilityReportingStatus`",
2457 "properties": {
2458 "owner": {
2459 "description": "The username or organization name that owns the repository. This field is not case-sensitive.",
2460 "examples": ["octocat", "github"],
2461 "title": "Owner",
2462 "type": "string"
2463 },
2464 "repo": {
2465 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
2466 "examples": ["hello-world", "linguist"],
2467 "title": "Repo",
2468 "type": "string"
2469 }
2470 },
2471 "required": ["owner", "repo"],
2472 "title": "CheckPrivateVulnerabilityReportingStatusRequest",
2473 "type": "object"
2474 },
2475 "output_parameters": {
2476 "properties": {
2477 "data": {
2478 "additionalProperties": true,
2479 "description": "A dictionary containing a boolean field `enabled` which is `true` if private vulnerability reporting is enabled for the repository, and `false` otherwise.",
2480 "title": "Data",
2481 "type": "object"
2482 },
2483 "error": {
2484 "default": null,
2485 "description": "Error if any occurred during the execution of the action",
2486 "nullable": true,
2487 "title": "Error",
2488 "type": "string"
2489 },
2490 "successful": {
2491 "description": "Whether or not the action execution was successful or not",
2492 "title": "Successful",
2493 "type": "boolean"
2494 }
2495 },
2496 "required": ["data", "successful"],
2497 "title": "CheckPrivateVulnerabilityReportingStatusResponseWrapper",
2498 "type": "object"
2499 },
2500 "description": "Checks if private vulnerability reporting is enabled for the specified repository.",
2501 "tags": ["readOnlyHint", "openWorldHint", "Security", "mcpIgnore"]
2502 },
2503 {
2504 "available_versions": ["latest"],
2505 "name": "Check team permissions for a project",
2506 "slug": "GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_PROJECT",
2507 "input_parameters": {
2508 "description": "Request schema for `CheckTeamPermissionsForAProject`",
2509 "properties": {
2510 "org": {
2511 "description": "The name of the organization. This is case-insensitive.",
2512 "examples": ["octo-org"],
2513 "title": "Org",
2514 "type": "string"
2515 },
2516 "project_id": {
2517 "description": "The unique identifier of the project (classic).",
2518 "examples": [1002604],
2519 "title": "Project Id",
2520 "type": "integer"
2521 },
2522 "team_slug": {
2523 "description": "The slug (short name) of the team.",
2524 "examples": ["justice-league"],
2525 "title": "Team Slug",
2526 "type": "string"
2527 }
2528 },
2529 "required": ["org", "team_slug", "project_id"],
2530 "title": "CheckTeamPermissionsForAProjectRequest",
2531 "type": "object"
2532 },
2533 "output_parameters": {
2534 "properties": {
2535 "data": {
2536 "additionalProperties": true,
2537 "description": "Details of the classic project, returned if the team has 'read', 'write', or 'admin' permissions. Includes project URLs, owner information, and other attributes.",
2538 "title": "Data",
2539 "type": "object"
2540 },
2541 "error": {
2542 "default": null,
2543 "description": "Error if any occurred during the execution of the action",
2544 "nullable": true,
2545 "title": "Error",
2546 "type": "string"
2547 },
2548 "successful": {
2549 "description": "Whether or not the action execution was successful or not",
2550 "title": "Successful",
2551 "type": "boolean"
2552 }
2553 },
2554 "required": ["data", "successful"],
2555 "title": "CheckTeamPermissionsForAProjectResponseWrapper",
2556 "type": "object"
2557 },
2558 "description": "Checks if a team has 'read', 'write', or 'admin' permissions for an organization's specific classic project, returning the project's details if access is confirmed.",
2559 "tags": ["readOnlyHint", "openWorldHint", "Organization Management", "mcpIgnore"]
2560 },
2561 {
2562 "available_versions": ["latest"],
2563 "name": "Check team permissions for a repository",
2564 "slug": "GITHUB_CHECK_TEAM_PERMISSIONS_FOR_A_REPOSITORY",
2565 "input_parameters": {
2566 "description": "Defines the request parameters for checking a team's permissions for a repository.",
2567 "properties": {
2568 "org": {
2569 "description": "The name of the organization. This field is not case-sensitive.",
2570 "examples": ["octo-org"],
2571 "title": "Org",
2572 "type": "string"
2573 },
2574 "owner": {
2575 "description": "The organization that owns the repository. For this GitHub API endpoint, this value must be the same as the `org` parameter. This field is not case-sensitive.",
2576 "examples": ["octo-org"],
2577 "title": "Owner",
2578 "type": "string"
2579 },
2580 "repo": {
2581 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
2582 "examples": ["hello-world", "octo-repo"],
2583 "title": "Repo",
2584 "type": "string"
2585 },
2586 "team_slug": {
2587 "description": "The URL-friendly slug for the team name. It is unique within the organization and typically all lowercase with hyphens instead of spaces.",
2588 "examples": ["justice-league", "awesome-developers"],
2589 "title": "Team Slug",
2590 "type": "string"
2591 }
2592 },
2593 "required": ["org", "team_slug", "owner", "repo"],
2594 "title": "CheckTeamPermissionsForARepositoryRequest",
2595 "type": "object"
2596 },
2597 "output_parameters": {
2598 "properties": {
2599 "data": {
2600 "additionalProperties": true,
2601 "description": "A dictionary representing the repository object, which includes the team's permissions for it. Key information includes a `permissions` attribute with boolean flags for `admin`, `maintain`, `push`, `triage`, and `pull` access.",
2602 "title": "Data",
2603 "type": "object"
2604 },
2605 "error": {
2606 "default": null,
2607 "description": "Error if any occurred during the execution of the action",
2608 "nullable": true,
2609 "title": "Error",
2610 "type": "string"
2611 },
2612 "successful": {
2613 "description": "Whether or not the action execution was successful or not",
2614 "title": "Successful",
2615 "type": "boolean"
2616 }
2617 },
2618 "required": ["data", "successful"],
2619 "title": "CheckTeamPermissionsForARepositoryResponseWrapper",
2620 "type": "object"
2621 },
2622 "description": "Checks a team's permissions for a specific repository within an organization, including permissions inherited from parent teams.",
2623 "tags": ["readOnlyHint", "openWorldHint", "Organization Management", "mcpIgnore"]
2624 },
2625 {
2626 "available_versions": ["latest"],
2627 "name": "Clear repository cache by key",
2628 "slug": "GITHUB_CLEAR_REPOSITORY_CACHE_BY_KEY",
2629 "input_parameters": {
2630 "description": "Request schema for the `ClearRepositoryCacheByKey` action, defining parameters to identify and delete GitHub Actions caches.",
2631 "properties": {
2632 "key": {
2633 "description": "The exact cache key used to identify specific caches for deletion. This key is often dynamically generated in workflows using expressions (e.g., `${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}`).",
2634 "examples": [
2635 "Linux-npm-6a99d79959699e7aa7597179767626e089597a38",
2636 "Windows-pip-cache-mybranch-py39",
2637 "macOS-gems-custom-key-v1"
2638 ],
2639 "title": "Key",
2640 "type": "string"
2641 },
2642 "owner": {
2643 "description": "The account owner of the repository. The name is not case sensitive.",
2644 "examples": ["octocat", "my-organization"],
2645 "title": "Owner",
2646 "type": "string"
2647 },
2648 "ref": {
2649 "description": "The full Git reference for narrowing down the cache deletion. For example, to target caches for a specific branch, use `refs/heads/<branch_name>`. To target caches for a pull request, use `refs/pull/<pull_number>/merge`. If omitted, caches matching the key across all refs are considered.",
2650 "examples": ["refs/heads/main", "refs/pull/123/merge", "refs/tags/v1.0.0"],
2651 "title": "Ref",
2652 "type": "string"
2653 },
2654 "repo": {
2655 "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
2656 "examples": ["hello-world", "my-awesome-project"],
2657 "title": "Repo",
2658 "type": "string"
2659 }
2660 },
2661 "required": ["owner", "repo", "key"],
2662 "title": "ClearRepositoryCacheByKeyRequest",
2663 "type": "object"
2664 },
2665 "output_parameters": {
2666 "properties": {
2667 "data": {
2668 "additionalProperties": true,
2669 "description": "A dictionary typically containing `total_count`, the number of caches deleted, and `actions_caches`, an array of the deleted cache objects.",
2670 "title": "Data",
2671 "type": "object"
2672 },
2673 "error": {
2674 "default": null,
2675 "description": "Error if any occurred during the execution of the action",
2676 "nullable": true,
2677 "title": "Error",
2678 "type": "string"
2679 },
2680 "successful": {
2681 "description": "Whether or not the action execution was successful or not",
2682 "title": "Successful",
2683 "type": "boolean"
2684 }
2685 },
2686 "required": ["data", "successful"],
2687 "title": "ClearRepositoryCacheByKeyResponseWrapper",
2688 "type": "object"
2689 },
2690 "description": "Deletes github actions caches from a repository matching a specific `key` and an optional git `ref`, used to manage storage or clear outdated/corrupted caches; the action succeeds even if no matching caches are found to delete.",
2691 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "CI/CD", "mcpIgnore"]
2692 },
2693 {
2694 "available_versions": ["latest"],
2695 "name": "Clear self-hosted runner org labels",
2696 "slug": "GITHUB_CLEAR_SELF_HOSTED_RUNNER_ORG_LABELS",
2697 "input_parameters": {
2698 "description": "Request schema for `ClearSelfHostedRunnerOrgLabels`",
2699 "properties": {
2700 "org": {
2701 "description": "Name of the organization (case-insensitive).",
2702 "examples": ["octo-org"],
2703 "title": "Org",
2704 "type": "string"
2705 },
2706 "runner_id": {
2707 "description": "Unique identifier of the self-hosted runner.",
2708 "examples": [123, 456],
2709 "title": "Runner Id",
2710 "type": "integer"
2711 }
2712 },
2713 "required": ["org", "runner_id"],
2714 "title": "ClearSelfHostedRunnerOrgLabelsRequest",
2715 "type": "object"
2716 },
2717 "output_parameters": {
2718 "properties": {
2719 "data": {
2720 "additionalProperties": true,
2721 "description": "Dictionary with the total count and list of remaining labels after clearing custom ones; GitHub-assigned default labels are not removed.",
2722 "title": "Data",
2723 "type": "object"
2724 },
2725 "error": {
2726 "default": null,
2727 "description": "Error if any occurred during the execution of the action",
2728 "nullable": true,
2729 "title": "Error",
2730 "type": "string"
2731 },
2732 "successful": {
2733 "description": "Whether or not the action execution was successful or not",
2734 "title": "Successful",
2735 "type": "boolean"
2736 }
2737 },
2738 "required": ["data", "successful"],
2739 "title": "ClearSelfHostedRunnerOrgLabelsResponseWrapper",
2740 "type": "object"
2741 },
2742 "description": "Removes all custom labels from a self-hosted runner for an organization; default labels (e.g., 'self-hosted', 'linux', 'x64') will remain.",
2743 "tags": ["destructiveHint", "idempotentHint", "openWorldHint", "CI/CD", "mcpIgnore"]
2744 },
2745 {
2746 "available_versions": ["latest"],
2747 "name": "Compare two commits",
2748 "slug": "GITHUB_COMPARE_TWO_COMMITS",
2749 "input_parameters": {
2750 "description": "Request schema for `CompareTwoCommits` action. Specifies the repository and the two commit points (base and head) to compare.",
2751 "properties": {
2752 "basehead": {
2753 "description": "A string specifying the base and head references to compare, in the format `BASE...HEAD`. `BASE` and `HEAD` can be branch names (e.g., `main...develop`), tag names (e.g., `v1.0.0...v1.1.0`), or commit SHA-1s. Both references must exist in the specified repository. To compare branches across forks in the same network, use the format `OWNER:REF...OWNER:REF` (e.g., `octocat:main...another-user:main`).",
2754 "examples": [
2755 "main...develop",
2756 "v1.0.0...v1.1.0",
2757 "0e9c6b6...5f8d3a0",
2758 "octocat:main...my-fork-user:main"
2759 ],
2760 "title": "Basehead",
2761 "type": "string"
2762 },
2763 "owner": {
2764 "description": "The username or organization name that owns the repository. This field is not case-sensitive.",
2765 "examples": ["octocat", "my-organization"],
2766 "title": "Owner",
2767 "type": "string"
2768 },
2769 "page": {
2770 "default": 1,
2771 "description": "Page number of the results to fetch, for pagination when the number of differences (commits or files) is large.",
2772 "examples": ["1", "2"],
2773 "title": "Page",
2774 "type": "integer"
2775 },
2776 "per_page": {
2777 "default": 30,
2778 "description": "Number of results (e.g., files or commits) to return per page, with a maximum of 100, for pagination.",
2779 "examples": ["30", "100"],
2780 "title": "Per Page",
2781 "type": "integer"
2782 },
2783 "repo": {
2784 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
2785 "examples": ["Spoon-Knife", "my-project"],
2786 "title": "Repo",
2787 "type": "string"
2788 }
2789 },
2790 "required": ["owner", "repo", "basehead"],
2791 "title": "CompareTwoCommitsRequest",
2792 "type": "object"
2793 },
2794 "output_parameters": {
2795 "properties": {
2796 "data": {
2797 "additionalProperties": true,
2798 "description": "A dictionary containing the comparison details. This typically includes: the status of the comparison (e.g., 'diverged', 'ahead', 'behind', 'identical'), the number of commits `ahead_by` and `behind_by` the base, `total_commits` in the range, an array of `commits` objects, an array of `files` objects detailing changed files (including status, additions, deletions, changes, patch, etc.), and various URLs (`html_url`, `permalink_url`, `diff_url`, `patch_url`) for accessing the comparison.",
2799 "title": "Data",
2800 "type": "object"
2801 },
2802 "error": {
2803 "default": null,
2804 "description": "Error if any occurred during the execution of the action",
2805 "nullable": true,
2806 "title": "Error",
2807 "type": "string"
2808 },
2809 "successful": {
2810 "description": "Whether or not the action execution was successful or not",
2811 "title": "Successful",
2812 "type": "boolean"
2813 }
2814 },
2815 "required": ["data", "successful"],
2816 "title": "CompareTwoCommitsResponseWrapper",
2817 "type": "object"
2818 },
2819 "description": "Compares two commit points (commits, branches, tags, or shas) within a repository or across forks, using `base...head` or `owner:ref...owner:ref` format for the `basehead` parameter.",
2820 "tags": ["readOnlyHint", "idempotentHint", "openWorldHint", "Commits", "important"]
2821 },
2822 {
2823 "available_versions": ["latest"],
2824 "name": "Configure JIT runner for an org",
2825 "slug": "GITHUB_CONFIGURE_JITRUNNER_FOR_ORG",
2826 "input_parameters": {
2827 "description": "Parameters to generate a just-in-time (JIT) runner configuration for a GitHub organization.",
2828 "properties": {
2829 "labels": {
2830 "description": "Custom labels to assign to the new self-hosted runner, used by GitHub Actions to route jobs. **Minimum items**: 1. **Maximum items**: 100.",
2831 "examples": [
2832 "[\"linux\", \"x64\", \"gpu\"]",
2833 "[\"windows-latest\", \"my-custom-label\"]"
2834 ],
2835 "items": { "properties": {}, "type": "string" },
2836 "title": "Labels",
2837 "type": "array"
2838 },
2839 "name": {
2840 "description": "Desired name for the new self-hosted runner, visible in the GitHub UI.",
2841 "examples": ["my-jit-runner-linux", "temp-builder-1"],
2842 "title": "Name",
2843 "type": "string"
2844 },
2845 "org": {
2846 "description": "Name of the GitHub organization (case-insensitive).",
2847 "examples": ["my-organization", "github"],
2848 "title": "Org",
2849 "type": "string"
2850 },
2851 "runner_group_id": {
2852 "description": "ID of the runner group to assign the new self-hosted runner. Must exist in the organization.",
2853 "examples": ["1", "42"],
2854 "title": "Runner Group Id",
2855 "type": "integer"
2856 },
2857 "work_folder": {
2858 "default": "_work",
2859 "description": "Path to the working directory on the runner machine where jobs will execute, relative to the runner's installation directory.",
2860 "examples": ["_work", "custom_work_dir"],
2861 "title": "Work Folder",
2862 "type": "string"
2863 }
2864 },
2865 "required": ["org", "name", "runner_group_id", "labels"],
2866 "title": "ConfigureJitrunnerForOrgRequest",
2867 "type": "object"
2868 },
2869 "output_parameters": {
2870 "properties": {
2871 "data": {
2872 "additionalProperties": true,
2873 "description": "Generated JIT configuration. Includes `runner` details (like `id`, `name`, `os`, `status`, `labels`) and `encoded_jit_config` (base64 encoded string for runner registration with GitHub Actions).",
2874 "title": "Data",
2875 "type": "object"
2876 },
2877 "error": {
2878 "default": null,
2879 "description": "Error if any occurred during the execution of the action",
2880 "nullable": true,
2881 "title": "Error",
2882 "type": "string"
2883 },
2884 "successful": {
2885 "description": "Whether or not the action execution was successful or not",
2886 "title": "Successful",
2887 "type": "boolean"
2888 }
2889 },
2890 "required": ["data", "successful"],
2891 "title": "ConfigureJitrunnerForOrgResponseWrapper",
2892 "type": "object"
2893 },
2894 "description": "Generates a jit configuration for a github organization's new self-hosted runner to run a single job then unregister; the runner group id must exist.",
2895 "tags": ["openWorldHint", "CI/CD", "mcpIgnore"]
2896 },
2897 {
2898 "available_versions": ["latest"],
2899 "name": "Configure OIDC subject claim template",
2900 "slug": "GITHUB_CONFIGURE_OIDCSUBJECT_CLAIM_TEMPLATE",
2901 "input_parameters": {
2902 "description": "Request schema for `ConfigureOidcsubjectClaimTemplate`.",
2903 "properties": {
2904 "include_claim_keys": {
2905 "description": "Array of unique strings, each a valid claim key (e.g., 'repo', 'actor'; alphanumeric/underscores only), to include in the OIDC subject claim (`sub`).",
2906 "examples": [
2907 ["repo", "context", "actor"],
2908 ["workflow", "ref", "repository_owner"]
2909 ],
2910 "items": { "properties": {}, "type": "string" },
2911 "title": "Include Claim Keys",
2912 "type": "array"
2913 },
2914 "org": {
2915 "description": "The GitHub organization name (case-insensitive).",
2916 "examples": ["my-github-org"],
2917 "title": "Org",
2918 "type": "string"
2919 }
2920 },
2921 "required": ["org", "include_claim_keys"],
2922 "title": "ConfigureOidcsubjectClaimTemplateRequest",
2923 "type": "object"
2924 },
2925 "output_parameters": {
2926 "properties": {
2927 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
2928 "error": {
2929 "default": null,
2930 "description": "Error if any occurred during the execution of the action",
2931 "nullable": true,
2932 "title": "Error",
2933 "type": "string"
2934 },
2935 "successful": {
2936 "description": "Whether or not the action execution was successful or not",
2937 "title": "Successful",
2938 "type": "boolean"
2939 }
2940 },
2941 "required": ["data", "successful"],
2942 "title": "ConfigureOidcsubjectClaimTemplateResponseWrapper",
2943 "type": "object"
2944 },
2945 "description": "Sets or updates the oidc subject claim customization template for an existing github organization by specifying which claims (e.g., 'repo', 'actor') form the oidc token's subject (`sub`).",
2946 "tags": [
2947 "updateHint",
2948 "idempotentHint",
2949 "openWorldHint",
2950 "Organization Management",
2951 "mcpIgnore"
2952 ]
2953 },
2954 {
2955 "available_versions": ["latest"],
2956 "name": "Convert an organization member to outside collaborator",
2957 "slug": "GITHUB_CONVERT_AN_ORGANIZATION_MEMBER_TO_OUTSIDE_COLLABORATOR",
2958 "input_parameters": {
2959 "description": "Request schema for `ConvertAnOrganizationMemberToOutsideCollaborator`",
2960 "properties": {
2961 "async": {
2962 "default": false,
2963 "description": "If true, performs the conversion asynchronously (API returns a 202 status when the job is successfully queued).",
2964 "title": "Async",
2965 "type": "boolean"
2966 },
2967 "org": {
2968 "description": "The organization name (case-insensitive).",
2969 "examples": ["octo-org", "my-company-gh"],
2970 "title": "Org",
2971 "type": "string"
2972 },
2973 "username": {
2974 "description": "The GitHub username of the member to convert.",
2975 "examples": ["octocat", "user-to-convert"],
2976 "title": "Username",
2977 "type": "string"
2978 }
2979 },
2980 "required": ["org", "username"],
2981 "title": "ConvertAnOrganizationMemberToOutsideCollaboratorRequest",
2982 "type": "object"
2983 },
2984 "output_parameters": {
2985 "properties": {
2986 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
2987 "error": {
2988 "default": null,
2989 "description": "Error if any occurred during the execution of the action",
2990 "nullable": true,
2991 "title": "Error",
2992 "type": "string"
2993 },
2994 "successful": {
2995 "description": "Whether or not the action execution was successful or not",
2996 "title": "Successful",
2997 "type": "boolean"
2998 }
2999 },
3000 "required": ["data", "successful"],
3001 "title": "ConvertAnOrganizationMemberToOutsideCollaboratorResponseWrapper",
3002 "type": "object"
3003 },
3004 "description": "Converts an existing organization member, who is not an owner, to an outside collaborator, restricting their access to explicitly granted repositories.",
3005 "tags": [
3006 "updateHint",
3007 "idempotentHint",
3008 "openWorldHint",
3009 "Organization Management",
3010 "mcpIgnore"
3011 ]
3012 },
3013 {
3014 "available_versions": ["latest"],
3015 "name": "Create an autolink reference for a repository",
3016 "slug": "GITHUB_CREATE_AN_AUTOLINK_REFERENCE_FOR_A_REPOSITORY",
3017 "input_parameters": {
3018 "description": "Request schema for creating an autolink reference in a repository.",
3019 "properties": {
3020 "is_alphanumeric": {
3021 "default": true,
3022 "description": "Specifies if the `<num>` placeholder in `url_template` matches alphanumeric characters (`A-Z` (case-insensitive), `0-9`, and `-`) or only numeric characters (`0-9`).",
3023 "examples": ["True", "False"],
3024 "title": "Is Alphanumeric",
3025 "type": "boolean"
3026 },
3027 "key_prefix": {
3028 "description": "Prefix that triggers the autolink (e.g., 'JIRA-'). When followed by an identifier, it's converted into a link. Must be non-empty and not contain spaces.",
3029 "examples": ["JIRA-", "TICKET-", "DOC-"],
3030 "title": "Key Prefix",
3031 "type": "string"
3032 },
3033 "owner": {
3034 "description": "The account owner of the repository. This can be a username or an organization name. The name is not case-sensitive.",
3035 "examples": ["octocat", "my-organization"],
3036 "title": "Owner",
3037 "type": "string"
3038 },
3039 "repo": {
3040 "description": "The name of the repository, without the `.git` extension. The name is not case-sensitive.",
3041 "examples": ["Spoon-Knife", "my-project"],
3042 "title": "Repo",
3043 "type": "string"
3044 },
3045 "url_template": {
3046 "description": "URL template for the autolink, using `<num>` as a placeholder for the reference identifier (e.g., 'https://example.atlassian.net/browse/<num>'). Behavior of `<num>` is determined by `is_alphanumeric`.",
3047 "examples": [
3048 "https://example.atlassian.net/browse/<num>",
3049 "https://tracker.example.com/issues?id=<num>"
3050 ],
3051 "title": "Url Template",
3052 "type": "string"
3053 }
3054 },
3055 "required": ["owner", "repo", "key_prefix", "url_template"],
3056 "title": "CreateAnAutolinkReferenceForARepositoryRequest",
3057 "type": "object"
3058 },
3059 "output_parameters": {
3060 "properties": {
3061 "data": {
3062 "additionalProperties": true,
3063 "description": "A dictionary representing the autolink reference object that was created. This typically includes fields such as `id`, `key_prefix`, `url_template`, and `is_alphanumeric`.",
3064 "title": "Data",
3065 "type": "object"
3066 },
3067 "error": {
3068 "default": null,
3069 "description": "Error if any occurred during the execution of the action",
3070 "nullable": true,
3071 "title": "Error",
3072 "type": "string"
3073 },
3074 "successful": {
3075 "description": "Whether or not the action execution was successful or not",
3076 "title": "Successful",
3077 "type": "boolean"
3078 }
3079 },
3080 "required": ["data", "successful"],
3081 "title": "CreateAnAutolinkReferenceForARepositoryResponseWrapper",
3082 "type": "object"
3083 },
3084 "description": "Creates a repository autolink to automatically convert text references (e.g., 'ticket-123') into hyperlinks, using a unique `key prefix` and a `url template` that includes `<num>`.",
3085 "tags": ["openWorldHint", "Repository Management", "mcpIgnore"]
3086 },
3087 {
3088 "available_versions": ["latest"],
3089 "name": "Create an environment variable",
3090 "slug": "GITHUB_CREATE_AN_ENVIRONMENT_VARIABLE",
3091 "input_parameters": {
3092 "description": "Request schema for creating a new environment variable in a repository's environment.",
3093 "properties": {
3094 "environment_name": {
3095 "description": "The name of the environment for which to create the variable. The name must be URL encoded if it contains special characters (e.g., slashes `/` must be replaced with `%2F`).",
3096 "examples": ["production", "staging%2Ffeature-branch"],
3097 "title": "Environment Name",
3098 "type": "string"
3099 },
3100 "name": {
3101 "description": "The name of the environment variable to create (e.g., `API_KEY`).",
3102 "examples": ["CI_TOKEN", "DATABASE_URL"],
3103 "title": "Name",
3104 "type": "string"
3105 },
3106 "owner": {
3107 "description": "The username or organization name that owns the repository. This field is not case-sensitive.",
3108 "examples": ["octocat"],
3109 "title": "Owner",
3110 "type": "string"
3111 },
3112 "repo": {
3113 "description": "The name of the repository, without the `.git` extension. This field is not case-sensitive.",
3114 "examples": ["hello-world"],
3115 "title": "Repo",
3116 "type": "string"
3117 },
3118 "value": {
3119 "description": "The value of the environment variable (e.g., `your_secret_token`). This value will be encrypted.",
3120 "examples": ["s3cr3t_v4lu3", "postgres://user:secret@localhost:5432/mydb"],
3121 "title": "Value",
3122 "type": "string"
3123 }
3124 },
3125 "required": ["owner", "repo", "environment_name", "name", "value"],
3126 "title": "CreateAnEnvironmentVariableRequest",
3127 "type": "object"
3128 },
3129 "output_parameters": {
3130 "properties": {
3131 "data": {
3132 "additionalProperties": true,
3133 "description": "An empty dictionary is returned upon successful creation of the environment variable (HTTP 201 Created).",
3134 "title": "Data",
3135 "type": "object"
3136 },
3137 "error": {
3138 "default": null,
3139 "description": "Error if any occurred during the execution of the action",
3140 "nullable": true,
3141 "title": "Error",
3142 "type": "string"
3143 },
3144 "successful": {
3145 "description": "Whether or not the action execution was successful or not",
3146 "title": "Successful",
3147 "type": "boolean"
3148 }
3149 },
3150 "required": ["data", "successful"],
3151 "title": "CreateAnEnvironmentVariableResponseWrapper",
3152 "type": "object"
3153 },
3154 "description": "Creates an encrypted environment variable for a pre-existing environment within a github repository; will fail if the variable name already exists.",
3155 "tags": ["openWorldHint", "CI/CD", "mcpIgnore"]
3156 },
3157 {
3158 "available_versions": ["latest"],
3159 "name": "Create an issue",
3160 "slug": "GITHUB_CREATE_AN_ISSUE",
3161 "input_parameters": {
3162 "description": "Request schema for creating a new issue in a GitHub repository.",
3163 "properties": {
3164 "assignee": {
3165 "description": "Login for the user to whom this issue should be assigned. NOTE: Only users with push access can set the assignee; it is silently dropped otherwise. **This field is deprecated in favor of `assignees`.**",
3166 "examples": ["octocat", "monalisa"],
3167 "title": "Assignee",
3168 "type": "string"
3169 },
3170 "assignees": {
3171 "description": "GitHub login names for users to assign to this issue. NOTE: Only users with push access can set assignees; they are silently dropped otherwise.",
3172 "examples": [["octocat"], ["monalisa", "hubot"]],
3173 "items": { "properties": {}, "type": "string" },
3174 "title": "Assignees",
3175 "type": "array"
3176 },
3177 "body": {
3178 "description": "The detailed textual contents of the new issue.",
3179 "examples": [
3180 "Detailed description of the bug with steps to reproduce.",
3181 "I think adding a dark mode would improve user experience..."
3182 ],
3183 "title": "Body",
3184 "type": "string"
3185 },
3186 "labels": {
3187 "description": "Label names to associate with this issue (generally case-insensitive). NOTE: Only users with push access can set labels; they are silently dropped otherwise. Pass an empty list to clear all labels.",
3188 "examples": [["bug", "critical"], ["enhancement", "ui"], ["documentation"]],
3189 "items": { "properties": {}, "type": "string" },
3190 "title": "Labels",
3191 "type": "array"
3192 },
3193 "milestone": {
3194 "description": "The ID of the milestone to associate this issue with (e.g., \"5\"). NOTE: Only users with push access can set the milestone; it is silently dropped otherwise.",
3195 "examples": ["1", "5"],
3196 "title": "Milestone",
3197 "type": "string"
3198 },
3199 "owner": {
3200 "description": "The GitHub account owner of the repository (case-insensitive).",
3201 "examples": ["octocat", "torvalds"],
3202 "title": "Owner",
3203 "type": "string"
3204 },
3205 "repo": {
3206 "description": "The name of the repository, without the `.git` extension (case-insensitive).",
3207 "examples": ["Spoon-Knife", "linux"],
3208 "title": "Repo",
3209 "type": "string"
3210 },
3211 "title": {
3212 "description": "The title for the new issue.",
3213 "examples": ["Found a critical bug", "Feature request: Add dark mode"],
3214 "title": "Title",
3215 "type": "string"
3216 }
3217 },
3218 "required": ["owner", "repo", "title"],
3219 "title": "CreateAnIssueRequest",
3220 "type": "object"
3221 },
3222 "output_parameters": {
3223 "properties": {
3224 "data": {
3225 "additionalProperties": true,
3226 "description": "A dictionary containing the full data representation of the newly created GitHub issue, including its ID, title, body, state, assignees, labels, etc.",
3227 "title": "Data",
3228 "type": "object"
3229 },
3230 "error": {
3231 "default": null,
3232 "description": "Error if any occurred during the execution of the action",
3233 "nullable": true,
3234 "title": "Error",
3235 "type": "string"
3236 },
3237 "successful": {
3238 "description": "Whether or not the action execution was successful or not",
3239 "title": "Successful",
3240 "type": "boolean"
3241 }
3242 },
3243 "required": ["data", "successful"],
3244 "title": "CreateAnIssueResponseWrapper",
3245 "type": "object"
3246 },
3247 "description": "Creates a new issue in a github repository, requiring the repository to exist and have issues enabled; specific fields like assignees, milestone, or labels may require push access.",
3248 "tags": ["important", "openWorldHint", "Repository Management"]
3249 },
3250 {
3251 "available_versions": ["latest"],
3252 "name": "Create an issue comment",
3253 "slug": "GITHUB_CREATE_AN_ISSUE_COMMENT",
3254 "input_parameters": {
3255 "description": "Parameters to create a comment on a GitHub issue or pull request.",
3256 "properties": {
3257 "body": {
3258 "description": "Comment content in GitHub Flavored Markdown.",
3259 "examples": ["This is a **bold** comment!", "Thanks for the update :+1:", "Fixes #123"],
3260 "title": "Body",
3261 "type": "string"
3262 },
3263 "issue_number": {
3264 "description": "Number identifying the issue or pull request for the comment.",
3265 "examples": [42, 101],
3266 "title": "Issue Number",
3267 "type": "integer"
3268 },
3269 "owner": {
3270 "description": "Account owner of the repository (username or organization); not case-sensitive.",
3271 "examples": ["octocat", "my-organization"],
3272 "title": "Owner",
3273 "type": "string"
3274 },
3275 "repo": {
3276 "description": "Name of the repository (without `.git` extension); not case-sensitive.",
3277 "examples": ["Spoon-Knife", "my-awesome-project"],
3278 "title": "Repo",
3279 "type": "string"
3280 }
3281 },
3282 "required": ["owner", "repo", "issue_number", "body"],
3283 "title": "CreateAnIssueCommentRequest",
3284 "type": "object"
3285 },
3286 "output_parameters": {
3287 "properties": {
3288 "data": {
3289 "additionalProperties": true,
3290 "description": "Full API response for the created issue comment, including ID, author, body, and timestamps.",
3291 "title": "Data",
3292 "type": "object"
3293 },
3294 "error": {
3295 "default": null,
3296 "description": "Error if any occurred during the execution of the action",
3297 "nullable": true,
3298 "title": "Error",
3299 "type": "string"
3300 },
3301 "successful": {
3302 "description": "Whether or not the action execution was successful or not",
3303 "title": "Successful",
3304 "type": "boolean"
3305 }
3306 },
3307 "required": ["data", "successful"],
3308 "title": "CreateAnIssueCommentResponseWrapper",
3309 "type": "object"
3310 },
3311 "description": "Creates a new comment on an existing github issue or pull request within the specified repository.",
3312 "tags": ["important", "openWorldHint", "Comments"]
3313 },
3314 {
3315 "available_versions": ["latest"],
3316 "name": "Create an organization project",
3317 "slug": "GITHUB_CREATE_AN_ORGANIZATION_PROJECT",
3318 "input_parameters": {
3319 "description": "Request to create a new classic project board in an organization.",
3320 "properties": {
3321 "body": {
3322 "description": "Body or description for the new project.",
3323 "examples": [
3324 "Tasks and milestones for the Q1 roadmap.",
3325 "Detailed plan and discussion for the website redesign project."
3326 ],
3327 "title": "Body",
3328 "type": "string"
3329 },
3330 "name": {
3331 "description": "Name for the new project.",
3332 "examples": ["Q1 Roadmap", "Website Redesign"],
3333 "title": "Name",
3334 "type": "string"
3335 },
3336 "org": {
3337 "description": "Name of the organization (not case-sensitive).",
3338 "examples": ["octocat", "github"],
3339 "title": "Org",
3340 "type": "string"
3341 }
3342 },
3343 "required": ["org", "name"],
3344 "title": "CreateAnOrganizationProjectRequest",
3345 "type": "object"
3346 },
3347 "output_parameters": {
3348 "properties": {
3349 "data": {
3350 "additionalProperties": true,
3351 "description": "Details of the newly created classic organization project.",
3352 "title": "Data",
3353 "type": "object"
3354 },
3355 "error": {
3356 "default": null,
3357 "description": "Error if any occurred during the execution of the action",
3358 "nullable": true,
3359 "title": "Error",
3360 "type": "string"
3361 },
3362 "successful": {
3363 "description": "Whether or not the action execution was successful or not",
3364 "title": "Successful",
3365 "type": "boolean"
3366 }
3367 },
3368 "required": ["data", "successful"],
3369 "title": "CreateAnOrganizationProjectResponseWrapper",
3370 "type": "object"
3371 },
3372 "description": "Creates a new classic project board within a specified github organization.",
3373 "tags": ["openWorldHint", "Organization Management", "mcpIgnore"]
3374 },
3375 {
3376 "available_versions": ["latest"],
3377 "name": "Create an organization repository",
3378 "slug": "GITHUB_CREATE_AN_ORGANIZATION_REPOSITORY",
3379 "input_parameters": {
3380 "description": "Request schema for creating a new repository in a GitHub organization.",
3381 "properties": {
3382 "allow_auto_merge": {
3383 "default": false,
3384 "description": "Allow auto-merge on pull requests.",
3385 "title": "Allow Auto Merge",
3386 "type": "boolean"
3387 },
3388 "allow_merge_commit": {
3389 "default": true,
3390 "description": "Allow merging pull requests with a merge commit.",
3391 "title": "Allow Merge Commit",
3392 "type": "boolean"
3393 },
3394 "allow_rebase_merge": {
3395 "default": true,
3396 "description": "Allow rebase-merging pull requests.",
3397 "title": "Allow Rebase Merge",
3398 "type": "boolean"
3399 },
3400 "allow_squash_merge": {
3401 "default": true,
3402 "description": "Allow squash-merging pull requests.",
3403 "title": "Allow Squash Merge",
3404 "type": "boolean"
3405 },
3406 "auto_init": {
3407 "default": false,
3408 "description": "Create an initial commit with an empty README.",
3409 "title": "Auto Init",
3410 "type": "boolean"
3411 },
3412 "custom_properties": {
3413 "additionalProperties": true,
3414 "description": "Custom properties for the repository as a key-value dictionary.",
3415 "examples": [{ "project_lead": "octocat", "status": "alpha" }],
3416 "title": "Custom Properties",
3417 "type": "object"
3418 },
3419 "delete_branch_on_merge": {
3420 "default": false,
3421 "description": "Automatically delete head branches when pull requests are merged. Requires organization owner privileges if true.",
3422 "title": "Delete Branch On Merge",
3423 "type": "boolean"
3424 },
3425 "description": {
3426 "description": "Short description of the repository.",
3427 "examples": ["A project to demonstrate awesome capabilities."],
3428 "title": "Description",
3429 "type": "string"
3430 },
3431 "gitignore_template": {
3432 "description": "Name of the .gitignore template to apply (e.g., \"Python\", \"Node\"). Refer to the [GitHub gitignore template list](https://github.com/github/gitignore).",
3433 "examples": ["Python"],
3434 "title": "Gitignore Template",
3435 "type": "string"
3436 },
3437 "has_downloads": {
3438 "default": true,
3439 "description": "Enable downloads for this repository (deprecated).",
3440 "title": "Has Downloads",
3441 "type": "boolean"
3442 },
3443 "has_issues": {
3444 "default": true,
3445 "description": "Enable issues for this repository.",
3446 "title": "Has Issues",
3447 "type": "boolean"
3448 },
3449 "has_projects": {
3450 "default": true,
3451 "description": "Enable projects for this repository. Fails if organization has disabled repository projects and this is true.",
3452 "title": "Has Projects",
3453 "type": "boolean"
3454 },
3455 "has_wiki": {
3456 "default": true,
3457 "description": "Enable wiki for this repository.",
3458 "title": "Has Wiki",
3459 "type": "boolean"
3460 },
3461 "homepage": {
3462 "description": "URL for the repository's homepage.",
3463 "examples": ["https://example.com/my-awesome-project"],
3464 "title": "Homepage",
3465 "type": "string"
3466 },
3467 "is_template": {
3468 "default": false,
3469 "description": "Make this repository a template repository.",
3470 "title": "Is Template",
3471 "type": "boolean"
3472 },
3473 "license_template": {
3474 "description": "License template keyword (e.g., \"mit\", \"apache-2.0\"). See [GitHub license documentation](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) for options.",
3475 "examples": ["mit"],
3476 "title": "License Template",
3477 "type": "string"
3478 },
3479 "merge_commit_message": {
3480 "description": "Default message for merge commits: 'PR_TITLE', 'PR_BODY', or 'BLANK'.",
3481 "enum": ["PR_BODY", "PR_TITLE", "BLANK"],
3482 "examples": ["PR_BODY"],
3483 "title": "Merge Commit Message",
3484 "type": "string"
3485 },
3486 "merge_commit_title": {
3487 "description": "Default title for merge commits: 'PR_TITLE' or 'MERGE_MESSAGE'.",
3488 "enum": ["PR_TITLE", "MERGE_MESSAGE"],
3489 "examples": ["MERGE_MESSAGE"],
3490 "title": "Merge Commit Title",
3491 "type": "string"
3492 },
3493 "name": {
3494 "description": "Name of the new repository.",
3495 "examples": ["new-awesome-project"],
3496 "title": "Name",
3497 "type": "string"
3498 },
3499 "org": {
3500 "description": "Name of the organization where the repository will be created (case-insensitive).",
3501 "examples": ["MyGitHubOrg"],
3502 "title": "Org",
3503 "type": "string"
3504 },
3505 "private": {
3506 "default": false,
3507 "description": "Whether the repository is private. `visibility` takes precedence if both are set.",
3508 "title": "Private",
3509 "type": "boolean"
3510 },
3511 "squash_merge_commit_message": {
3512 "description": "Default message for squash merge commits: 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK'.",
3513 "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"],
3514 "examples": ["PR_BODY"],
3515 "title": "Squash Merge Commit Message",
3516 "type": "string"
3517 },
3518 "squash_merge_commit_title": {
3519 "description": "Default title for squash merge commits: 'PR_TITLE' or 'COMMIT_OR_PR_TITLE'.",
3520 "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"],
3521 "examples": ["PR_TITLE"],
3522 "title": "Squash Merge Commit Title",
3523 "type": "string"
3524 },
3525 "team_id": {
3526 "description": "ID of the team to grant access to this repository within the organization.",
3527 "examples": [12345],
3528 "title": "Team Id",
3529 "type": "integer"
3530 },
3531 "use_squash_pr_title_as_default": {
3532 "default": false,
3533 "description": "DEPRECATED: Use `squash_merge_commit_title`. Default to pull request title for squash-merge commits.",
3534 "title": "Use Squash Pr Title As Default",
3535 "type": "boolean"
3536 },
3537 "visibility": {
3538 "description": "Repository visibility: 'public' (visible to everyone) or 'private' (visible to collaborators).",
3539 "enum": ["public", "private"],
3540 "examples": ["public"],
3541 "title": "Visibility",
3542 "type": "string"
3543 }
3544 },
3545 "required": ["org", "name"],
3546 "title": "CreateAnOrganizationRepositoryRequest",
3547 "type": "object"
3548 },
3549 "output_parameters": {
3550 "properties": {
3551 "data": {
3552 "additionalProperties": true,
3553 "description": "A dictionary containing the full representation of the newly created repository.",
3554 "title": "Data",
3555 "type": "object"
3556 },
3557 "error": {
3558 "default": null,
3559 "description": "Error if any occurred during the execution of the action",
3560 "nullable": true,
3561 "title": "Error",
3562 "type": "string"
3563 },
3564 "successful": {
3565 "description": "Whether or not the action execution was successful or not",
3566 "title": "Successful",
3567 "type": "boolean"
3568 }
3569 },
3570 "required": ["data", "successful"],
3571 "title": "CreateAnOrganizationRepositoryResponseWrapper",
3572 "type": "object"
3573 },
3574 "description": "Creates a new repository within a specified github organization, with options for detailed configuration including visibility, features, merge strategies, initial commit, and templates.",
3575 "tags": ["important", "openWorldHint", "Repository Management"]
3576 },
3577 {
3578 "available_versions": ["latest"],
3579 "name": "Create an organization variable",
3580 "slug": "GITHUB_CREATE_AN_ORGANIZATION_VARIABLE",
3581 "input_parameters": {
3582 "description": "Request schema for `CreateAnOrganizationVariable`",
3583 "properties": {
3584 "name": {
3585 "description": "The name of the organization variable. Must be unique at the organization level.",
3586 "examples": ["CI_TOKEN", "DEPLOY_SERVER_URL"],
3587 "title": "Name",
3588 "type": "string"
3589 },
3590 "org": {
3591 "description": "The name of the GitHub organization. This name is not case-sensitive.",
3592 "examples": ["github", "my-organization"],
3593 "title": "Org",
3594 "type": "string"
3595 },
3596 "selected_repository_ids": {
3597 "description": "A list of repository integer IDs that can access this organization variable. This field is required and only applicable when `visibility` is set to 'selected'.",
3598 "examples": ["[1296269, 1296270]", "[98765]"],
3599 "items": { "properties": {}, "type": "integer" },
3600 "title": "Selected Repository Ids",
3601 "type": "array"
3602 },
3603 "value": {
3604 "description": "The value of the organization variable.",
3605 "examples": ["your_secret_token_value", "https://api.staging.example.com"],
3606 "title": "Value",
3607 "type": "string"
3608 },
3609 "visibility": {
3610 "description": "Controls which repositories in the organization can access the variable. Accepted values are 'all' (all repositories), 'private' (only private repositories), or 'selected' (specific repositories designated by `selected_repository_ids`).",
3611 "enum": ["all", "private", "selected"],
3612 "examples": ["all", "private", "selected"],
3613 "title": "Visibility",
3614 "type": "string"
3615 }
3616 },
3617 "required": ["org", "name", "value", "visibility"],
3618 "title": "CreateAnOrganizationVariableRequest",
3619 "type": "object"
3620 },
3621 "output_parameters": {
3622 "properties": {
3623 "data": {
3624 "additionalProperties": true,
3625 "description": "An empty dictionary indicating the successful creation of the organization variable, as the GitHub API typically returns an empty body (201 Created) for this operation.",
3626 "title": "Data",
3627 "type": "object"
3628 },
3629 "error": {
3630 "default": null,
3631 "description": "Error if any occurred during the execution of the action",
3632 "nullable": true,
3633 "title": "Error",
3634 "type": "string"
3635 },
3636 "successful": {
3637 "description": "Whether or not the action execution was successful or not",
3638 "title": "Successful",
3639 "type": "boolean"
3640 }
3641 },
3642 "required": ["data", "successful"],
3643 "title": "CreateAnOrganizationVariableResponseWrapper",
3644 "type": "object"
3645 },
3646 "description": "Creates a new, uniquely named github actions variable for an organization, with configurable repository access visibility (all, private, or selected).",
3647 "tags": ["openWorldHint", "CI/CD", "mcpIgnore"]
3648 },
3649 {
3650 "available_versions": ["latest"],
3651 "name": "Create an organization webhook",
3652 "slug": "GITHUB_CREATE_AN_ORGANIZATION_WEBHOOK",
3653 "input_parameters": {
3654 "description": "Request schema for `CreateAnOrganizationWebhook`",
3655 "properties": {
3656 "active": {
3657 "default": true,
3658 "description": "Boolean indicating if the webhook is active. `true` sends notifications, `false` does not. Defaults to `true`.",
3659 "title": "Active",
3660 "type": "boolean"
3661 },
3662 "config__content__type": {
3663 "description": "The media type for serializing webhook payloads. Supported: `json`, `form`. GitHub API defaults to `form` if this field is not set or is `None`.",
3664 "examples": ["json", "form"],
3665 "title": "Config Content Type",
3666 "type": "string"
3667 },
3668 "config__insecure__ssl": {
3669 "description": "Controls SSL certificate verification for `config_url`. '1' disables verification (not recommended), '0' enables. GitHub API defaults to '0' (verification enabled) if this field is not set or is `None`.",
3670 "examples": ["0", "1"],
3671 "title": "Config Insecure Ssl",
3672 "type": "string"
3673 },
3674 "config__password": {
3675 "description": "Password for basic authentication if the webhook endpoint (`config_url`) requires it, corresponding to `config_username`.",
3676 "examples": ["p@$$wOrd", "securePassword123"],
3677 "title": "Config Password",
3678 "type": "string"
3679 },
3680 "config__secret": {
3681 "description": "Optional secret for generating an HMAC hex digest for payload verification (X-Hub-Signature-256 header). If provided, this is used as the key.",
3682 "examples": ["s3cr3tT0k3n", "mySup3rS3cur3K3y"],
3683 "title": "Config Secret",
3684 "type": "string"
3685 },
3686 "config__url": {
3687 "description": "The target URL for webhook payload delivery. This URL is a mandatory part of the webhook's `config` object and will receive POST requests for subscribed events.",
3688 "examples": ["https://example.com/webhook", "https://my-service.com/github-events"],
3689 "format": "uri",
3690 "title": "Config Url",
3691 "type": "string"
3692 },
3693 "config__username": {
3694 "description": "Username for basic authentication if the webhook endpoint (`config_url`) requires it. Use only if your endpoint is protected by basic auth.",
3695 "examples": ["webhook-user", "admin"],
3696 "title": "Config Username",
3697 "type": "string"
3698 },
3699 "events": {
3700 "default": ["push"],
3701 "description": "List of event names to trigger the webhook. Use `['*']` for all events. Defaults to `['push']` if not specified. See GitHub docs for event types.",
3702 "examples": [["push", "issues"], ["*"], ["release"], ["check_run"]],
3703 "items": { "properties": {}, "type": "string" },
3704 "title": "Events",
3705 "type": "array"
3706 },
3707 "name": {
3708 "description": "The name of the webhook. Must be \"web\" for organization webhooks.",
3709 "title": "Name",
3710 "type": "string"
3711 },
3712 "org": {
3713 "description": "The name of the GitHub organization. This name is not case-sensitive.",
3714 "examples": ["my-cool-org", "GitHub"],
3715 "title": "Org",
3716 "type": "string"
3717 }
3718 },
3719 "required": ["org", "name"],
3720 "title": "CreateAnOrganizationWebhookRequest",
3721 "type": "object"
3722 },
3723 "output_parameters": {
3724 "properties": {
3725 "data": {
3726 "additionalProperties": true,
3727 "description": "A dictionary containing the complete JSON representation of the created webhook object as returned by the GitHub API.",
3728 "title": "Data",
3729 "type": "object"
3730 },
3731 "error": {
3732 "default": null,
3733 "description": "Error if any occurred during the execution of the action",
3734 "nullable": true,
3735 "title": "Error",
3736 "type": "string"
3737 },
3738 "successful": {
3739 "description": "Whether or not the action execution was successful or not",
3740 "title": "Successful",
3741 "type": "boolean"
3742 }
3743 },
3744 "required": ["data", "successful"],
3745 "title": "CreateAnOrganizationWebhookResponseWrapper",
3746 "type": "object"
3747 },
3748 "description": "Creates a webhook for a github organization to deliver event notifications to a configured url.",
3749 "tags": ["openWorldHint", "Organization Management", "mcpIgnore"]
3750 },
3751 {
3752 "available_versions": ["latest"],
3753 "name": "Create a blob",
3754 "slug": "GITHUB_CREATE_A_BLOB",
3755 "input_parameters": {
3756 "description": "Defines the request parameters for creating a new Git blob.",
3757 "properties": {
3758 "content": {
3759 "description": "The content to be stored in the new blob.",
3760 "examples": ["This is the raw content of the file.", "SGVsbG8gV29ybGQ=\\n"],
3761 "title": "Content",
3762 "type": "string"
3763 },
3764 "encoding": {
3765 "default": "utf-8",
3766 "description": "The encoding for the 'content'; \"utf-8\" or \"base64\".",
3767 "examples": ["utf-8", "base64"],
3768 "title": "Encoding",
3769 "type": "string"
3770 },
3771 "owner": {
3772 "description": "The username or organization name that owns the repository. This field is not case-sensitive.",
3773 "examples": ["octocat"],
3774 "title": "Owner",
3775 "type": "string"
3776 },
3777 "repo": {
3778 "description": "The name of the repository, without the '.git' extension. This field is not case-sensitive.",
3779 "examples": ["Hello-World"],
3780 "title": "Repo",
3781 "type": "string"
3782 }
3783 },
3784 "required": ["owner", "repo", "content"],
3785 "title": "CreateABlobRequest",
3786 "type": "object"
3787 },
3788 "output_parameters": {
3789 "properties": {
3790 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
3791 "error": {
3792 "default": null,
3793 "description": "Error if any occurred during the execution of the action",
3794 "nullable": true,
3795 "title": "Error",
3796 "type": "string"
3797 },
3798 "successful": {
3799 "description": "Whether or not the action execution was successful or not",
3800 "title": "Successful",
3801 "type": "boolean"
3802 }
3803 },
3804 "required": ["data", "successful"],
3805 "title": "CreateABlobResponseWrapper",
3806 "type": "object"
3807 },
3808 "description": "Creates a git blob in a repository, requiring content and encoding ('utf-8' or 'base64').",
3809 "tags": ["openWorldHint", "Repository Management", "important"]
3810 },
3811 {
3812 "available_versions": ["latest"],
3813 "name": "Create a check run",
3814 "slug": "GITHUB_CREATE_A_CHECK_RUN",
3815 "input_parameters": {
3816 "description": "Request schema to create a new check run on GitHub.",
3817 "properties": {
3818 "actions": {
3819 "description": "A list of up to three action objects defining interactive buttons displayed on GitHub after the check run completes. Each object needs a `label` (button text), `identifier` (unique ID for the action), and `description` (tooltip). Clicking a button sends a `check_run.requested_action` webhook to your app.",
3820 "items": { "additionalProperties": true, "properties": {}, "type": "object" },
3821 "title": "Actions",
3822 "type": "array"
3823 },
3824 "completed_at": {
3825 "description": "The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run finished. **Required if `status` is `completed`**.",
3826 "examples": ["2018-05-04T01:14:52Z"],
3827 "format": "date-time",
3828 "title": "Completed At",
3829 "type": "string"
3830 },
3831 "conclusion": {
3832 "description": "**Required if `completed_at` is provided or if `status` is `completed`**. Specifies the final outcome of the check (e.g., 'success', 'failure'). Note: Setting `conclusion` automatically sets `status` to `completed`. GitHub alone can set a conclusion to `stale`.",
3833 "enum": [
3834 "action_required",
3835 "cancelled",
3836 "failure",
3837 "neutral",
3838 "success",
3839 "skipped",
3840 "stale",
3841 "timed_out"
3842 ],
3843 "title": "Conclusion",
3844 "type": "string"
3845 },
3846 "details_url": {
3847 "description": "The URL of the integrator's site providing full details of the check. If omitted, the GitHub App's homepage is used. This URL is available from the check's UI.",
3848 "examples": ["https://example.com/build/status"],
3849 "title": "Details Url",
3850 "type": "string"
3851 },
3852 "external_id": {
3853 "description": "A unique identifier for the check run on the integrator's system. This helps in correlating check runs between GitHub and the external system.",
3854 "examples": ["42"],
3855 "title": "External Id",
3856 "type": "string"
3857 },
3858 "head_sha": {
3859 "description": "The SHA of the commit for which the check run is created.",
3860 "examples": ["009b8392b1d19195ab1750317ce01ed503788888"],
3861 "title": "Head Sha",
3862 "type": "string"
3863 },
3864 "name": {
3865 "description": "The name of the check to be displayed in the GitHub UI. For example, \"Code Coverage\" or \"Linter\".",
3866 "examples": ["mighty_linter"],
3867 "title": "Name",
3868 "type": "string"
3869 },
3870 "output__annotations": {
3871 "description": "A list of annotation objects detailing issues at specific code locations. Annotations are visible in the 'Checks' and 'Files changed' tabs of a pull request. Each annotation object should specify `path`, `start_line`, `end_line`, `annotation_level` ('notice', 'warning', or 'failure'), and `message`. Optional fields include `start_column`, `end_column`, `title`, and `raw_details`. Up to 50 annotations per API request; for more, use subsequent 'Update a check run' calls. GitHub Actions limits are 10 warnings and 10 errors per step.",
3872 "items": { "additionalProperties": true, "properties": {}, "type": "object" },
3873 "title": "Output Annotations",
3874 "type": "array"
3875 },
3876 "output__images": {
3877 "description": "A list of image objects to display in the check run's output in the GitHub UI. Each object requires `alt` (alternative text), `image_url` (URL of the image), and an optional `caption`.",
3878 "items": { "additionalProperties": true, "properties": {}, "type": "object" },
3879 "title": "Output Images",
3880 "type": "array"
3881 },
3882 "output__summary": {
3883 "description": "A summary of the check run's findings. Supports Markdown. **Maximum length**: 65,535 characters.",
3884 "examples": ["Found 2 critical issues and 5 warnings."],
3885 "title": "Output Summary",
3886 "type": "string"
3887 },
3888 "output__text": {
3889 "description": "Detailed textual information about the check run's output. Supports Markdown. **Maximum length**: 65,535 characters.",
3890 "title": "Output Text",
3891 "type": "string"
3892 },
3893 "output__title": {
3894 "description": "A descriptive title for the output of the check run, displayed in the GitHub UI. For example, 'Linter Scan Summary'.",
3895 "examples": ["Linter Scan Summary"],
3896 "title": "Output Title",
3897 "type": "string"
3898 },
3899 "owner": {
3900 "description": "The account owner of the repository. This name is not case sensitive.",
3901 "examples": ["octocat"],
3902 "title": "Owner",
3903 "type": "string"
3904 },
3905 "repo": {
3906 "description": "The name of the repository, without the `.git` extension. This name is not case sensitive.",
3907 "examples": ["Hello-World"],
3908 "title": "Repo",
3909 "type": "string"
3910 },
3911 "started_at": {
3912 "description": "The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run began.",
3913 "examples": ["2018-05-04T01:14:52Z"],
3914 "format": "date-time",
3915 "title": "Started At",
3916 "type": "string"
3917 },
3918 "status": {
3919 "default": "queued",
3920 "description": "The current status of the check run. Only GitHub Actions can set `status` to `waiting`, `pending`, or `requested`.",
3921 "enum": ["queued", "in_progress", "completed", "waiting", "requested", "pending"],
3922 "title": "Status",
3923 "type": "string"
3924 }
3925 },
3926 "required": ["owner", "repo", "name", "head_sha"],
3927 "title": "CreateACheckRunRequest",
3928 "type": "object"
3929 },
3930 "output_parameters": {
3931 "properties": {
3932 "data": {
3933 "additionalProperties": true,
3934 "description": "A dictionary representing the full check run object as created by the API. This includes fields like `id`, `node_id`, `head_sha`, `status`, `conclusion`, `name`, `details_url`, `external_id`, `started_at`, `completed_at`, `output` (containing summary, text, annotations, images), `app` (information about the GitHub App that created the check run), and `pull_requests` (an array of pull requests associated with the commit).",
3935 "title": "Data",
3936 "type": "object"
3937 },
3938 "error": {
3939 "default": null,
3940 "description": "Error if any occurred during the execution of the action",
3941 "nullable": true,
3942 "title": "Error",
3943 "type": "string"
3944 },
3945 "successful": {
3946 "description": "Whether or not the action execution was successful or not",
3947 "title": "Successful",
3948 "type": "boolean"
3949 }
3950 },
3951 "required": ["data", "successful"],
3952 "title": "CreateACheckRunResponseWrapper",
3953 "type": "object"
3954 },
3955 "description": "Creates a new check run for a specific commit in a repository, used by external services to report status, detailed feedback, annotations, and images directly within the github ui.",
3956 "tags": ["checks", "openWorldHint"]
3957 },
3958 {
3959 "available_versions": ["latest"],
3960 "name": "Create a check suite",
3961 "slug": "GITHUB_CREATE_A_CHECK_SUITE",
3962 "input_parameters": {
3963 "description": "Request schema for `CreateACheckSuite`",
3964 "properties": {
3965 "head_sha": {
3966 "description": "SHA of the commit for which to create the check suite, typically the head commit of a branch.",
3967 "examples": ["7638417db6d59f3c431d3e1f261cc637155684cd"],
3968 "title": "Head Sha",
3969 "type": "string"
3970 },
3971 "owner": {
3972 "description": "Account owner of the repository (case-insensitive).",
3973 "examples": ["octocat"],
3974 "title": "Owner",
3975 "type": "string"
3976 },
3977 "repo": {
3978 "description": "Repository name, without the `.git` extension (case-insensitive).",
3979 "examples": ["Hello-World"],
3980 "title": "Repo",
3981 "type": "string"
3982 }
3983 },
3984 "required": ["owner", "repo", "head_sha"],
3985 "title": "CreateACheckSuiteRequest",
3986 "type": "object"
3987 },
3988 "output_parameters": {
3989 "properties": {
3990 "data": {
3991 "additionalProperties": true,
3992 "description": "Details of the newly created check suite.",
3993 "title": "Data",
3994 "type": "object"
3995 },
3996 "error": {
3997 "default": null,
3998 "description": "Error if any occurred during the execution of the action",
3999 "nullable": true,
4000 "title": "Error",
4001 "type": "string"
4002 },
4003 "successful": {
4004 "description": "Whether or not the action execution was successful or not",
4005 "title": "Successful",
4006 "type": "boolean"
4007 }
4008 },
4009 "required": ["data", "successful"],
4010 "title": "CreateACheckSuiteResponseWrapper",
4011 "type": "object"
4012 },
4013 "description": "Creates a new check suite for a specific commit (`head sha`) in an original repository (not a fork); github dispatches a `check suite` webhook event with the `requested` action upon success.",
4014 "tags": ["checks", "openWorldHint"]
4015 },
4016 {
4017 "available_versions": ["latest"],
4018 "name": "Create a codespace for the authenticated user",
4019 "slug": "GITHUB_CREATE_A_CODESPACE_FOR_THE_AUTHENTICATED_USER",
4020 "input_parameters": {
4021 "description": "Request body for POST /user/codespaces.\n\nProvide either:\n- repository_id (int) + ref (string branch/commit/PR ref), or\n- pull_request object with pull_request_number (int) and repository_id (int).\n\nOther optional fields supported by the API (machine, location, devcontainer_path, etc.) can be added later if needed.",
4022 "properties": {
4023 "pull_request": {
4024 "additionalProperties": false,
4025 "default": null,
4026 "nullable": true,
4027 "properties": {
4028 "pull_request_number": {
4029 "description": "Pull request number.",
4030 "title": "Pull Request Number",
4031 "type": "integer"
4032 },
4033 "repository_id": {
4034 "description": "Repository ID for the pull request.",
4035 "title": "Repository Id",
4036 "type": "integer"
4037 }
4038 },
4039 "required": ["pull_request_number", "repository_id"],
4040 "title": "PullRequestPayload",
4041 "type": "object"
4042 },
4043 "ref": {
4044 "default": null,
4045 "description": "Git ref (branch, tag, or commit SHA) to use for the codespace.",
4046 "examples": ["main", "refs/heads/main", "a1b2c3d"],
4047 "nullable": true,
4048 "title": "Ref",
4049 "type": "string"
4050 },
4051 "repository_id": {
4052 "default": null,
4053 "description": "ID of the repository to create the codespace from.",
4054 "nullable": true,
4055 "title": "Repository Id",
4056 "type": "integer"
4057 }
4058 },
4059 "title": "CreateACodespaceForTheAuthenticatedUserRequest",
4060 "type": "object"
4061 },
4062 "output_parameters": {
4063 "properties": {
4064 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
4065 "error": {
4066 "default": null,
4067 "description": "Error if any occurred during the execution of the action",
4068 "nullable": true,
4069 "title": "Error",
4070 "type": "string"
4071 },
4072 "successful": {
4073 "description": "Whether or not the action execution was successful or not",
4074 "title": "Successful",
4075 "type": "boolean"
4076 }
4077 },
4078 "required": ["data", "successful"],
4079 "title": "CreateACodespaceForTheAuthenticatedUserResponseWrapper",
4080 "type": "object"
4081 },
4082 "description": "Creates a github codespace for the authenticated user, requiring a json request body with either `repository id` (integer) or a `pull request` object (containing `pull request number` (integer) and `repository id` (integer)).",
4083 "tags": ["codespaces", "openWorldHint"]
4084 },
4085 {
4086 "available_versions": ["latest"],
4087 "name": "Create a codespace from a pull request",
4088 "slug": "GITHUB_CREATE_A_CODESPACE_FROM_A_PULL_REQUEST",
4089 "input_parameters": {
4090 "description": "Request to create a GitHub Codespace from a pull request, specifying its configuration.",
4091 "properties": {
4092 "client_ip": {
4093 "description": "Client's public IP address for location auto-detection if proxied and `geo` or `location` are not specified.",
4094 "examples": ["192.0.2.1"],
4095 "title": "Client Ip",
4096 "type": "string"
4097 },
4098 "devcontainer_path": {
4099 "description": "Path to a `devcontainer.json` file in the repository that defines the development environment.",
4100 "examples": [".devcontainer/devcontainer.json", "devcontainer.json"],
4101 "title": "Devcontainer Path",
4102 "type": "string"
4103 },
4104 "display_name": {
4105 "description": "Custom name for the codespace.",
4106 "examples": ["My Feature Branch Codespace"],
4107 "title": "Display Name",
4108 "type": "string"
4109 },
4110 "geo": {
4111 "description": "Geographic area for this codespace (e.g., `UsEast`, `EuropeWest`); supersedes `location`. If unspecified, typically IP-derived.",
4112 "enum": ["EuropeWest", "SoutheastAsia", "UsEast", "UsWest"],
4113 "examples": ["UsEast", "EuropeWest", "SoutheastAsia"],
4114 "title": "Geo",
4115 "type": "string"
4116 },
4117 "idle_timeout_minutes": {
4118 "description": "Minutes of inactivity after which the codespace is automatically stopped. A default timeout applies if unspecified.",
4119 "examples": [30, 60],
4120 "title": "Idle Timeout Minutes",
4121 "type": "integer"
4122 },
4123 "location": {
4124 "description": "Requested geographic location (e.g., `EastUs`, `WestEurope`). This parameter is deprecated; use `geo`. If unspecified, location may be IP-derived.",
4125 "examples": ["EastUs", "WestEurope"],
4126 "title": "Location",
4127 "type": "string"
4128 },
4129 "machine": {
4130 "description": "Machine type for this codespace (e.g., `standardLinux`). Varies by CPU, RAM, storage. Uses default if unspecified.",
4131 "examples": [
4132 "standardLinux",
4133 "standardLinux8gb",
4134 "standardLinux16gb",
4135 "standardLinux32gb"
4136 ],
4137 "title": "Machine",
4138 "type": "string"
4139 },
4140 "multi_repo_permissions_opt_out": {
4141 "description": "Set to `true` to prevent GitHub from requesting additional repository permissions defined in `devcontainer.json`. Defaults to `false` (permissions will be requested).",
4142 "title": "Multi Repo Permissions Opt Out",
4143 "type": "boolean"
4144 },
4145 "owner": {
4146 "description": "The username of the account that owns the repository. This is case-insensitive.",
4147 "examples": ["octocat"],
4148 "title": "Owner",
4149 "type": "string"
4150 },
4151 "pull_number": {
4152 "description": "The unique number identifying the pull request.",
4153 "examples": [1347],
4154 "title": "Pull Number",
4155 "type": "integer"
4156 },
4157 "repo": {
4158 "description": "The name of the repository, without the `.git` extension. This is case-insensitive.",
4159 "examples": ["Spoon-Knife"],
4160 "title": "Repo",
4161 "type": "string"
4162 },
4163 "retention_period_minutes": {
4164 "description": "Retention period in minutes (0-43200, i.e., up to 30 days) for a stopped codespace. 0 means immediate deletion.",
4165 "examples": [1440, 43200],
4166 "title": "Retention Period Minutes",
4167 "type": "integer"
4168 },
4169 "working_directory": {
4170 "description": "Working directory for the codespace upon opening. Defaults to the repository root if unspecified.",
4171 "examples": ["/workspaces/my-project/src"],
4172 "title": "Working Directory",
4173 "type": "string"
4174 }
4175 },
4176 "required": ["owner", "repo", "pull_number"],
4177 "title": "CreateACodespaceFromAPullRequestRequest",
4178 "type": "object"
4179 },
4180 "output_parameters": {
4181 "properties": {
4182 "data": {
4183 "additionalProperties": true,
4184 "description": "Full details of the created codespace.",
4185 "title": "Data",
4186 "type": "object"
4187 },
4188 "error": {
4189 "default": null,
4190 "description": "Error if any occurred during the execution of the action",
4191 "nullable": true,
4192 "title": "Error",
4193 "type": "string"
4194 },
4195 "successful": {
4196 "description": "Whether or not the action execution was successful or not",
4197 "title": "Successful",
4198 "type": "boolean"
4199 }
4200 },
4201 "required": ["data", "successful"],
4202 "title": "CreateACodespaceFromAPullRequestResponseWrapper",
4203 "type": "object"
4204 },
4205 "description": "Creates a github codespace for an open pull request in a codespaces-enabled repository, with options to customize its configuration.",
4206 "tags": ["codespaces", "openWorldHint"]
4207 },
4208 {
4209 "available_versions": ["latest"],
4210 "name": "Create a codespace in a repository",
4211 "slug": "GITHUB_CREATE_A_CODESPACE_IN_A_REPOSITORY",
4212 "input_parameters": {
4213 "description": "Request schema for `CreateACodespaceInARepository`",
4214 "properties": {
4215 "client_ip": {
4216 "description": "IP address to infer preferred region if `location` and `geo` are unspecified; useful for proxied requests.",
4217 "examples": ["192.168.1.100"],
4218 "title": "Client Ip",
4219 "type": "string"
4220 },
4221 "devcontainer_path": {
4222 "description": "Path to a `devcontainer.json` in the repository; uses `.devcontainer/devcontainer.json` or `devcontainer.json` at root if not specified.",
4223 "examples": [".devcontainer/my-custom-devcontainer.json"],
4224 "title": "Devcontainer Path",
4225 "type": "string"
4226 },
4227 "display_name": {
4228 "description": "Custom display name for the codespace; a default name is generated if not provided.",
4229 "examples": ["My Development Codespace"],
4230 "title": "Display Name",
4231 "type": "string"
4232 },
4233 "geo": {
4234 "description": "Geographic area for the codespace, replacing `location`; determined by user IP if not specified.",
4235 "enum": ["EuropeWest", "SoutheastAsia", "UsEast", "UsWest"],
4236 "examples": ["EuropeWest", "SoutheastAsia", "UsEast", "UsWest"],
4237 "title": "Geo",
4238 "type": "string"
4239 },
4240 "idle_timeout_minutes": {
4241 "description": "Minutes of inactivity before codespace auto-stops; uses a default timeout if not specified.",
4242 "examples": [30, 60],
4243 "title": "Idle Timeout Minutes",
4244 "type": "integer"
4245 },
4246 "location": {
4247 "description": "Requested AWS region (best-effort, may differ); determined by user IP if not provided. Deprecated: use `geo`.",
4248 "examples": ["EastUs", "WestUs", "WestEurope", "SoutheastAsia"],
4249 "title": "Location",
4250 "type": "string"
4251 },
4252 "machine": {
4253 "description": "Machine type (CPU, RAM, storage). See 'List available machine types for a repository' action for options; uses a default type if not specified.",
4254 "examples": ["standardLinux", "premiumLinux"],
4255 "title": "Machine",
4256 "type": "string"
4257 },
4258 "multi_repo_permissions_opt_out": {
4259 "description": "If `true`, opts out of granting multi-repository permissions from `devcontainer.json`. If unspecified or `false`, permissions are granted if requested.",
4260 "examples": [true, false],
4261 "title": "Multi Repo Permissions Opt Out",
4262 "type": "boolean"
4263 },
4264 "owner": {
4265 "description": "Username or organization name owning the repository; not case-sensitive.",
4266 "examples": ["octocat", "Microsoft"],
4267 "title": "Owner",
4268 "type": "string"
4269 },
4270 "ref": {
4271 "description": "Git reference (e.g., branch name) for the codespace; uses repository's default branch if not provided.",
4272 "examples": ["main", "feature-branch-name"],
4273 "title": "Ref",
4274 "type": "string"
4275 },
4276 "repo": {
4277 "description": "Name of the repository, without the `.git` extension; not case-sensitive.",
4278 "examples": ["Spoon-Knife", "vscode"],
4279 "title": "Repo",
4280 "type": "string"
4281 },
4282 "retention_period_minutes": {
4283 "description": "Minutes an idle (stopped) codespace is retained before auto-deletion (0-43200, i.e., up to 30 days); uses a default period if not specified.",
4284 "examples": [1440, 43200],
4285 "title": "Retention Period Minutes",
4286 "type": "integer"
4287 },
4288 "working_directory": {
4289 "description": "Directory to use as default when codespace opens; uses repository root if not specified.",
4290 "examples": ["/projects/my-app"],
4291 "title": "Working Directory",
4292 "type": "string"
4293 }
4294 },
4295 "required": ["owner", "repo"],
4296 "title": "CreateACodespaceInARepositoryRequest",
4297 "type": "object"
4298 },
4299 "output_parameters": {
4300 "properties": {
4301 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
4302 "error": {
4303 "default": null,
4304 "description": "Error if any occurred during the execution of the action",
4305 "nullable": true,
4306 "title": "Error",
4307 "type": "string"
4308 },
4309 "successful": {
4310 "description": "Whether or not the action execution was successful or not",
4311 "title": "Successful",
4312 "type": "boolean"
4313 }
4314 },
4315 "required": ["data", "successful"],
4316 "title": "CreateACodespaceInARepositoryResponseWrapper",
4317 "type": "object"
4318 },
4319 "description": "Creates a github codespace for the authenticated user in a specified repository, which must be accessible and use a valid `devcontainer.json` if `devcontainer path` is specified.",
4320 "tags": ["codespaces", "openWorldHint"]
4321 },
4322 {
4323 "available_versions": ["latest"],
4324 "name": "Create a commit",
4325 "slug": "GITHUB_CREATE_A_COMMIT",
4326 "input_parameters": {
4327 "description": "Defines the parameters to create a new commit in a GitHub repository.",
4328 "properties": {
4329 "author__date": {
4330 "description": "Timestamp (ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`) when the commit was authored.",
4331 "examples": ["2024-01-15T10:30:00Z"],
4332 "format": "date-time",
4333 "title": "Author Date",
4334 "type": "string"
4335 },
4336 "author__email": {
4337 "description": "Email of the commit's author. Defaults to authenticated user if not provided.",
4338 "examples": ["mona@example.com"],
4339 "title": "Author Email",
4340 "type": "string"
4341 },
4342 "author__name": {
4343 "description": "Name of the commit's author. Defaults to authenticated user if not provided.",
4344 "examples": ["Mona Lisa Octocat"],
4345 "title": "Author Name",
4346 "type": "string"
4347 },
4348 "committer__date": {
4349 "description": "Timestamp (ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`) when the commit was committed. Defaults to `author_date` or current time.",
4350 "examples": ["2024-01-15T10:35:00Z"],
4351 "format": "date-time",
4352 "title": "Committer Date",
4353 "type": "string"
4354 },
4355 "committer__email": {
4356 "description": "Email of the committer. Defaults to author's email or authenticated user if not provided.",
4357 "examples": ["octocat@example.com"],
4358 "title": "Committer Email",
4359 "type": "string"
4360 },
4361 "committer__name": {
4362 "description": "Name of the committer. Defaults to author's name or authenticated user if not provided.",
4363 "examples": ["The Octocat"],
4364 "title": "Committer Name",
4365 "type": "string"
4366 },
4367 "message": {
4368 "description": "The commit message.",
4369 "examples": ["feat: implement user authentication endpoint"],
4370 "title": "Message",
4371 "type": "string"
4372 },
4373 "owner": {
4374 "description": "Account owner of the repository (case-insensitive).",
4375 "examples": ["octocat"],
4376 "title": "Owner",
4377 "type": "string"
4378 },
4379 "parents": {
4380 "description": "SHAs of parent commits; all must exist in the repository. Omit or provide an empty list for a root commit.",
4381 "examples": [
4382 "[\"1a2b3c4d5e6f7g8h9i0jabcdef1234567890\"]",
4383 "[\"parent_sha_main\", \"parent_sha_feature_branch\"]"
4384 ],
4385 "items": { "properties": {}, "type": "string" },
4386 "title": "Parents",
4387 "type": "array"
4388 },
4389 "repo": {
4390 "description": "Name of the repository, without the `.git` extension (case-insensitive).",
4391 "examples": ["Spoon-Knife"],
4392 "title": "Repo",
4393 "type": "string"
4394 },
4395 "signature": {
4396 "description": "ASCII-armored detached PGP signature over the commit data. GitHub adds this to the `gpgsig` header if provided.",
4397 "examples": ["-----BEGIN PGP SIGNATURE-----\\n...\\n-----END PGP SIGNATURE-----"],
4398 "title": "Signature",
4399 "type": "string"
4400 },
4401 "tree": {
4402 "description": "SHA of the tree object for this commit; must exist in the repository.",
4403 "examples": ["9c1a209e10072fe99393945673ace821a4827669"],
4404 "title": "Tree",
4405 "type": "string"
4406 }
4407 },
4408 "required": ["owner", "repo", "message", "tree"],
4409 "title": "CreateACommitRequest",
4410 "type": "object"
4411 },
4412 "output_parameters": {
4413 "properties": {
4414 "data": {
4415 "additionalProperties": true,
4416 "description": "Details of the created commit, including SHA, URL, author/committer info, tree, message, parents, and verification status.",
4417 "title": "Data",
4418 "type": "object"
4419 },
4420 "error": {
4421 "default": null,
4422 "description": "Error if any occurred during the execution of the action",
4423 "nullable": true,
4424 "title": "Error",
4425 "type": "string"
4426 },
4427 "successful": {
4428 "description": "Whether or not the action execution was successful or not",
4429 "title": "Successful",
4430 "type": "boolean"
4431 }
4432 },
4433 "required": ["data", "successful"],
4434 "title": "CreateACommitResponseWrapper",
4435 "type": "object"
4436 },
4437 "description": "Creates a new commit in a github repository; the `tree` sha and any `parents` shas must already exist in the repository.",
4438 "tags": ["git", "openWorldHint", "important"]
4439 },
4440 {
4441 "available_versions": ["latest"],
4442 "name": "Create a commit comment",
4443 "slug": "GITHUB_CREATE_A_COMMIT_COMMENT",
4444 "input_parameters": {
4445 "description": "Request to create a comment on a specific commit or a line within a file's diff in a commit.",
4446 "properties": {
4447 "body": {
4448 "description": "The text content of the comment.",
4449 "examples": ["This is a great commit!", "LGTM :+1:"],
4450 "title": "Body",
4451 "type": "string"
4452 },
4453 "commit_sha": {
4454 "description": "The SHA identifier of the commit to comment on.",
4455 "examples": ["a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"],
4456 "title": "Commit Sha",
4457 "type": "string"
4458 },
4459 "line": {
4460 "description": "**Deprecated:** Use `position` instead. Line number in the file to comment on. `position` takes precedence if both are provided.",
4461 "examples": ["5", "23"],
4462 "title": "Line",
4463 "type": "integer"
4464 },
4465 "owner": {
4466 "description": "The username or organization name that owns the repository.",
4467 "examples": ["octocat", "github"],
4468 "title": "Owner",
4469 "type": "string"
4470 },
4471 "path": {
4472 "description": "Relative path of the file to comment on. If specified, `position` is also required.",
4473 "examples": ["src/main.py", "docs/README.md"],
4474 "title": "Path",
4475 "type": "string"
4476 },
4477 "position": {
4478 "description": "Line number in the diff's patch to comment on, relative to the commit's changes. Required if `path` is specified.",
4479 "examples": ["1", "15"],
4480 "title": "Position",
4481 "type": "integer"
4482 },
4483 "repo": {
4484 "description": "The name of the repository, without the `.git` extension.",
4485 "examples": ["Spoon-Knife", "my-project"],
4486 "title": "Repo",
4487 "type": "string"
4488 }
4489 },
4490 "required": ["owner", "repo", "commit_sha", "body"],
4491 "title": "CreateACommitCommentRequest",
4492 "type": "object"
4493 },
4494 "output_parameters": {
4495 "properties": {
4496 "data": {
4497 "additionalProperties": true,
4498 "description": "Full representation of the newly created commit comment.",
4499 "title": "Data",
4500 "type": "object"
4501 },
4502 "error": {
4503 "default": null,
4504 "description": "Error if any occurred during the execution of the action",
4505 "nullable": true,
4506 "title": "Error",
4507 "type": "string"
4508 },
4509 "successful": {
4510 "description": "Whether or not the action execution was successful or not",
4511 "title": "Successful",
4512 "type": "boolean"
4513 }
4514 },
4515 "required": ["data", "successful"],
4516 "title": "CreateACommitCommentResponseWrapper",
4517 "type": "object"
4518 },
4519 "description": "Creates a comment on a specific commit, or on a specific line if `path` and `position` are provided.",
4520 "tags": ["openWorldHint", "repos"]
4521 },
4522 {
4523 "available_versions": ["latest"],
4524 "name": "Create a commit status",
4525 "slug": "GITHUB_CREATE_A_COMMIT_STATUS",
4526 "input_parameters": {
4527 "description": "Request schema for `CreateACommitStatus`",
4528 "properties": {
4529 "context": {
4530 "default": "default",
4531 "description": "Label to differentiate this status from other systems (e.g., 'ci/jenkins'); case-insensitive.",
4532 "examples": ["ci/jenkins", "linter/eslint", "default"],
4533 "title": "Context",
4534 "type": "string"
4535 },
4536 "description": {
4537 "description": "Human-readable description of the status, displayed in GitHub UI.",
4538 "examples": [
4539 "Build successful",
4540 "Tests passed with 0 failures",
4541 "Deployment to staging failed"
4542 ],
4543 "title": "Description",
4544 "type": "string"
4545 },
4546 "owner": {
4547 "description": "Username or organization name of the repository owner (case-insensitive).",
4548 "examples": ["octocat", "github"],
4549 "title": "Owner",
4550 "type": "string"
4551 },
4552 "repo": {
4553 "description": "Repository name, without the `.git` extension (case-insensitive).",
4554 "examples": ["Hello-World", "Spoon-Knife"],
4555 "title": "Repo",
4556 "type": "string"
4557 },
4558 "sha": {
4559 "description": "SHA hash of the commit.",
4560 "examples": [
4561 "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
4562 "6dcb09b5b57875f334f61aebed695e2e4193db5e"
4563 ],
4564 "title": "Sha",
4565 "type": "string"
4566 },
4567 "state": {
4568 "description": "State of the commit status, indicating check outcome or phase.",
4569 "enum": ["error", "failure", "pending", "success"],
4570 "examples": ["error", "failure", "pending", "success"],
4571 "title": "State",
4572 "type": "string"
4573 },
4574 "target_url": {
4575 "description": "URL linking to the source of the status (e.g., CI build log), displayed in GitHub UI.",
4576 "examples": [
4577 "http://ci.example.com/user/repo/build/sha",
4578 "https://example.com/deployment/status/123"
4579 ],
4580 "title": "Target Url",
4581 "type": "string"
4582 }
4583 },
4584 "required": ["owner", "repo", "sha", "state"],
4585 "title": "CreateACommitStatusRequest",
4586 "type": "object"
4587 },
4588 "output_parameters": {
4589 "properties": {
4590 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
4591 "error": {
4592 "default": null,
4593 "description": "Error if any occurred during the execution of the action",
4594 "nullable": true,
4595 "title": "Error",
4596 "type": "string"
4597 },
4598 "successful": {
4599 "description": "Whether or not the action execution was successful or not",
4600 "title": "Successful",
4601 "type": "boolean"
4602 }
4603 },
4604 "required": ["data", "successful"],
4605 "title": "CreateACommitStatusResponseWrapper",
4606 "type": "object"
4607 },
4608 "description": "Sets a commit's status (e.g., error, failure, pending, success from ci/cd) for a given sha; max 1000 statuses per sha/context.",
4609 "tags": ["openWorldHint", "repos", "mcpIgnore"]
4610 },
4611 {
4612 "available_versions": ["latest"],
4613 "name": "Create a custom organization role",
4614 "slug": "GITHUB_CREATE_A_CUSTOM_ORGANIZATION_ROLE",
4615 "input_parameters": {
4616 "description": "Request to create a custom organization role.",
4617 "properties": {
4618 "description": {
4619 "description": "Optional short description of the custom role's purpose or permissions.",
4620 "examples": [
4621 "Grants read-only access to organization settings and member audit logs.",
4622 "Allows managing repository security advisories."
4623 ],
4624 "title": "Description",
4625 "type": "string"
4626 },
4627 "name": {
4628 "description": "Unique name for the custom role.",
4629 "examples": ["Triage Access", "Security Auditor", "Release Manager"],
4630 "title": "Name",
4631 "type": "string"
4632 },
4633 "org": {
4634 "description": "Name of the GitHub organization (case-insensitive) where the custom role will be created.",
4635 "examples": ["github", "my-company-org"],
4636 "title": "Org",
4637 "type": "string"
4638 },
4639 "permissions": {
4640 "description": "List of permission strings defining actions granted by this role; see GitHub docs for available permissions.",
4641 "examples": [
4642 "read:org",
4643 "manage_runners:org",
4644 "create_repository",
4645 "administer_repository",
4646 "delete_issues"
4647 ],
4648 "items": { "properties": {}, "type": "string" },
4649 "title": "Permissions",
4650 "type": "array"
4651 }
4652 },
4653 "required": ["org", "name", "permissions"],
4654 "title": "CreateACustomOrganizationRoleRequest",
4655 "type": "object"
4656 },
4657 "output_parameters": {
4658 "properties": {
4659 "data": {
4660 "additionalProperties": true,
4661 "description": "Details of the created custom role, including `id`, `name`, `description`, `permissions`, and `organization`.",
4662 "title": "Data",
4663 "type": "object"
4664 },
4665 "error": {
4666 "default": null,
4667 "description": "Error if any occurred during the execution of the action",
4668 "nullable": true,
4669 "title": "Error",
4670 "type": "string"
4671 },
4672 "successful": {
4673 "description": "Whether or not the action execution was successful or not",
4674 "title": "Successful",
4675 "type": "boolean"
4676 }
4677 },
4678 "required": ["data", "successful"],
4679 "title": "CreateACustomOrganizationRoleResponseWrapper",
4680 "type": "object"
4681 },
4682 "description": "Creates a custom role with defined permissions within a github organization.",
4683 "tags": ["openWorldHint", "orgs", "mcpIgnore"]
4684 },
4685 {
4686 "available_versions": ["latest"],
4687 "name": "Create a deployment",
4688 "slug": "GITHUB_CREATE_A_DEPLOYMENT",
4689 "input_parameters": {
4690 "description": "Request schema for `CreateADeployment`",
4691 "properties": {
4692 "auto_merge": {
4693 "default": true,
4694 "description": "Attempts to automatically merge the default branch into the requested ref if the ref is behind the default branch. Set to `false` to disable.",
4695 "title": "Auto Merge",
4696 "type": "boolean"
4697 },
4698 "description": {
4699 "description": "A short description of the deployment. Maximum length of 1000 characters.",
4700 "examples": ["Deploying new feature X to staging.", "Hotfix for critical bug #123."],
4701 "title": "Description",
4702 "type": "string"
4703 },
4704 "environment": {
4705 "default": "production",
4706 "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
4707 "examples": ["production", "staging", "develop", "qa"],
4708 "title": "Environment",
4709 "type": "string"
4710 },
4711 "owner": {
4712 "description": "The account owner of the repository. This name is not case-sensitive.",
4713 "title": "Owner",
4714 "type": "string"
4715 },
4716 "payload": {
4717 "description": "A JSON string payload providing additional information that a deployment system might need, customizable based on the deployment process.",
4718 "examples": [
4719 "'''{\"deploy_tool\": \"custom_script\", \"target_environment\": \"server_alpha\"}'''",
4720 "'''{\"user_initiating\": \"admin_user\"}'''"
4721 ],
4722 "title": "Payload",
4723 "type": "string"
4724 },
4725 "production_environment": {
4726 "description": "Specifies if the given environment is one that end-users directly interact with.",
4727 "title": "Production Environment",
4728 "type": "boolean"
4729 },
4730 "ref": {
4731 "description": "The ref to deploy. This can be a branch name, a tag name, or a commit SHA.",
4732 "examples": ["main", "v1.2.3", "c0ff335h4c0d3f0r3x4mpl3"],
4733 "title": "Ref",
4734 "type": "string"
4735 },
4736 "repo": {
4737 "description": "The name of the repository, without the `.git` extension. This name is not case-sensitive. ",
4738 "title": "Repo",
4739 "type": "string"
4740 },
4741 "required_contexts": {
4742 "description": "A list of status check contexts to verify against commit status checks before creating the deployment. If omitted or `null`, GitHub verifies all unique contexts. Pass an empty list `[]` to bypass all checks.",
4743 "examples": [["continuous-integration/jenkins", "security/snyk"], []],
4744 "items": { "properties": {}, "type": "string" },
4745 "title": "Required Contexts",
4746 "type": "array"
4747 },
4748 "task": {
4749 "default": "deploy",
4750 "description": "Specifies a task to execute, e.g., `deploy` or `deploy:migrations`.",
4751 "examples": ["deploy", "deploy:migrations", "build_and_deploy"],
4752 "title": "Task",
4753 "type": "string"
4754 },
4755 "transient_environment": {
4756 "default": false,
4757 "description": "Specifies if the given environment is specific to this deployment and will no longer exist at some point in the future (e.g., a staging environment for a pull request). Set to `true` if the environment is temporary.",
4758 "title": "Transient Environment",
4759 "type": "boolean"
4760 }
4761 },
4762 "required": ["owner", "repo", "ref"],
4763 "title": "CreateADeploymentRequest",
4764 "type": "object"
4765 },
4766 "output_parameters": {
4767 "properties": {
4768 "data": {
4769 "additionalProperties": true,
4770 "description": "A dictionary representing the created deployment object as returned by the GitHub API.",
4771 "title": "Data",
4772 "type": "object"
4773 },
4774 "error": {
4775 "default": null,
4776 "description": "Error if any occurred during the execution of the action",
4777 "nullable": true,
4778 "title": "Error",
4779 "type": "string"
4780 },
4781 "successful": {
4782 "description": "Whether or not the action execution was successful or not",
4783 "title": "Successful",
4784 "type": "boolean"
4785 }
4786 },
4787 "required": ["data", "successful"],
4788 "title": "CreateADeploymentResponseWrapper",
4789 "type": "object"
4790 },
4791 "description": "Creates a github deployment for an existing repository, targeting a specific ref (branch, tag, or sha) that must also exist within the repository.",
4792 "tags": ["openWorldHint", "repos"]
4793 },
4794 {
4795 "available_versions": ["latest"],
4796 "name": "Create a deployment branch policy",
4797 "slug": "GITHUB_CREATE_A_DEPLOYMENT_BRANCH_POLICY",
4798 "input_parameters": {
4799 "description": "Request schema for `CreateADeploymentBranchPolicy`",
4800 "properties": {
4801 "environment_name": {
4802 "description": "Name of the target environment; URL-encode special characters (e.g., `/` as `%2F`).",
4803 "examples": ["production", "staging%2Ffrontend", "development_v2"],
4804 "title": "Environment Name",
4805 "type": "string"
4806 },
4807 "name": {
4808 "description": "Name pattern for deployable branches/tags (Ruby File.fnmatch syntax; `*` won't match `/`, e.g., `release/*/*` for `release/feature/login`). Refer to [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
4809 "examples": ["main", "releases/*", "feature/user-*", "v*.*.*"],
4810 "title": "Name",
4811 "type": "string"
4812 },
4813 "owner": {
4814 "description": "Account owner of the repository (not case sensitive).",
4815 "examples": ["octocat", "my-organization"],
4816 "title": "Owner",
4817 "type": "string"
4818 },
4819 "repo": {
4820 "description": "Name of the repository, without the `.git` extension (not case sensitive).",
4821 "examples": ["hello-world", "my-app-repository"],
4822 "title": "Repo",
4823 "type": "string"
4824 },
4825 "type": {
4826 "description": "Whether the policy targets a Git branch or a tag.",
4827 "enum": ["branch", "tag"],
4828 "examples": ["branch", "tag"],
4829 "title": "Type",
4830 "type": "string"
4831 }
4832 },
4833 "required": ["owner", "repo", "environment_name", "name"],
4834 "title": "CreateADeploymentBranchPolicyRequest",
4835 "type": "object"
4836 },
4837 "output_parameters": {
4838 "properties": {
4839 "data": {
4840 "additionalProperties": true,
4841 "description": "Details of the created deployment branch policy.",
4842 "title": "Data",
4843 "type": "object"
4844 },
4845 "error": {
4846 "default": null,
4847 "description": "Error if any occurred during the execution of the action",
4848 "nullable": true,
4849 "title": "Error",
4850 "type": "string"
4851 },
4852 "successful": {
4853 "description": "Whether or not the action execution was successful or not",
4854 "title": "Successful",
4855 "type": "boolean"
4856 }
4857 },
4858 "required": ["data", "successful"],
4859 "title": "CreateADeploymentBranchPolicyResponseWrapper",
4860 "type": "object"
4861 },
4862 "description": "Creates a deployment branch or tag policy for an existing environment in a github repository, using a ruby file.fnmatch pattern (where `*` doesn't match `/`) to specify which branches or tags are deployable.",
4863 "tags": ["openWorldHint", "repos", "mcpIgnore"]
4864 },
4865 {
4866 "available_versions": ["latest"],
4867 "name": "Create a deployment status",
4868 "slug": "GITHUB_CREATE_A_DEPLOYMENT_STATUS",
4869 "input_parameters": {
4870 "description": "Request schema for `CreateADeploymentStatus`",
4871 "properties": {
4872 "auto_inactive": {
4873 "description": "If true, sets prior successful, non-transient, non-production deployments in the same repository and environment to `inactive`.",
4874 "examples": ["true", "false"],
4875 "title": "Auto Inactive",
4876 "type": "boolean"
4877 },
4878 "deployment_id": {
4879 "description": "The unique identifier of the deployment for which to create a status.",
4880 "examples": [12345],
4881 "title": "Deployment Id",
4882 "type": "integer"
4883 },
4884 "description": {
4885 "description": "Short description of the status (max 140 characters).",
4886 "examples": ["Deployment to staging completed successfully."],
4887 "title": "Description",
4888 "type": "string"
4889 },
4890 "environment": {
4891 "description": "Name for the target deployment environment (e.g., `production`, `staging`). If unset, uses environment from previous status or deployment.",
4892 "examples": ["production", "staging"],
4893 "title": "Environment",
4894 "type": "string"
4895 },
4896 "environment_url": {
4897 "description": "URL for accessing the target deployment environment.",
4898 "examples": ["https://myapp-staging.example.com"],
4899 "title": "Environment Url",
4900 "type": "string"
4901 },
4902 "log_url": {
4903 "description": "URL for deployment output. Preferred over `target_url`; setting this also sets `target_url` to the same value.",
4904 "examples": ["https://ci.example.com/job/my-app/15/console"],
4905 "title": "Log Url",
4906 "type": "string"
4907 },
4908 "owner": {
4909 "description": "The account owner of the repository. The name is not case sensitive.",
4910 "examples": ["octocat"],
4911 "title": "Owner",
4912 "type": "string"
4913 },
4914 "repo": {
4915 "description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
4916 "examples": ["hello-world"],
4917 "title": "Repo",
4918 "type": "string"
4919 },
4920 "state": {
4921 "description": "State of the status. Setting a transient deployment to `inactive` shows it as `destroyed` in GitHub.",
4922 "enum": ["error", "failure", "inactive", "in_progress", "queued", "pending", "success"],
4923 "examples": ["success", "pending", "failure"],
4924 "title": "State",
4925 "type": "string"
4926 },
4927 "target_url": {
4928 "description": "URL for deployment status updates or output. `log_url` is generally preferred.",
4929 "examples": ["https://example.com/deployment/output/123"],
4930 "title": "Target Url",
4931 "type": "string"
4932 }
4933 },
4934 "required": ["owner", "repo", "deployment_id", "state"],
4935 "title": "CreateADeploymentStatusRequest",
4936 "type": "object"
4937 },
4938 "output_parameters": {
4939 "properties": {
4940 "data": { "additionalProperties": true, "title": "Data", "type": "object" },
4941 "error": {
4942 "default": null,
4943 "description": "Error if any occurred during the execution of the action",
4944 "nullable": true,
4945 "title": "Error",
4946 "type": "string"
4947 },
4948 "successful": {
4949 "description": "Whether or not the action execution was successful or not",
4950 "title": "Successful",
4951 "type": "boolean"
4952 }
4953 },
4954 "required": ["data", "successful"],
4955 "title": "CreateADeploymentStatusResponseWrapper",
4956 "type": "object"
4957 },
4958 "description": "Creates a status for an existing deployment, updating its operational state, associated urls, and description.",
4959 "tags": ["openWorldHint", "repos", "mcpIgnore"]
4960 },
4961 {
4962 "available_versions": ["latest"],
4963 "name": "Create a deploy key",
4964 "slug": "GITHUB_CREATE_A_DEPLOY_KEY",
4965 "input_parameters": {
4966 "description": "Request schema for creating a deploy key, which is an SSH key granting access to a single repository.",
4967 "properties": {
4968 "key": {
4969 "description": "The full public SSH key. Ensure this is the public key, not the private key.",
4970 "examples": ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC... user@example.com"],
4971 "title": "Key",
4972 "type": "string"
4973 },
4974 "owner": {
4975 "description": "The username of the account that owns the repository. This is not case sensitive.",
4976 "examples": ["octocat"],
4977 "title": "Owner",
4978 "type": "string"
4979 },
4980 "read_only": {
4981 "description": "If `true`, the deploy key will only have read access. If `false` (default), the key will have read and write access. Write access grants significant privileges.",
4982 "examples": [true, false],
4983 "title": "Read Only",
4984 "type": "boolean"
4985 },
4986 "repo": {
4987 "description": "The name of the repository, without the `.git` extension. This is not case sensitive.",
4988 "examples": ["Hello-World"],
4989 "title": "Repo",
4990 "type": "string"
4991 },
4992 "title": {
4993 "description": "A descriptive name for the new deploy key. If not provided, a default name will be generated.",
4994 "examples": ["Staging Server Key"],
4995 "title": "Title",
4996 "type": "string"
4997 }
4998 },
4999 "required": ["owner", "repo", "key"],
5000 "title": "CreateADeployKeyRequest",
Showing first 5,000 of 77,114 lines. View raw