Skip to content

Commit 284bf70

Browse files
committed
Add documentation for initial Gist tools
1 parent 2eb1887 commit 284bf70

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,10 +606,36 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
606606
- `prNumber`: Pull request number (string, required)
607607
- `path`: File or directory path (string, optional)
608608

609+
## Gists
610+
611+
### list_gists
612+
- **Description**: List gists for a user.
613+
- **Parameters**:
614+
- `username` (string, optional): GitHub username (omit for authenticated user's gists).
615+
- `since` (string, optional): Only gists updated after this time (ISO 8601 timestamp).
616+
- `page` (number, optional): Page number.
617+
- `perPage` (number, optional): Results per page.
618+
619+
### create_gist
620+
- **Description**: Create a new gist.
621+
- **Parameters**:
622+
- `description` (string, optional): Description of the gist.
623+
- `filename` (string, required): Filename for gist file
624+
- `content` (string, required): Content for gist file
625+
- `public` (boolean, optional): Whether the gist is public (default: false).
626+
627+
### update_gist
628+
- **Description**: Update an existing gist.
629+
- **Parameters**:
630+
- `gist_id` (string, required): ID of the gist to update.
631+
- `description` (string, optional): Updated description of the gist.
632+
- `filename` (string, required): Filename to update or create.
633+
- `content` (string, required): Content for the file.
634+
609635
## Library Usage
610636

611637
The exported Go API of this module should currently be considered unstable, and subject to breaking changes. In the future, we may offer stability; please file an issue if there is a use case where this would be valuable.
612638

613639
## License
614640

615-
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
641+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.

0 commit comments

Comments
 (0)