Skip to content

Commit 98035d3

Browse files
committed
Add documentation for initial Gist tools
1 parent 569a8b7 commit 98035d3

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,8 @@ The following sets of tools are available (all are on by default):
294294
| `repos` | GitHub Repository related tools |
295295
| `secret_protection` | Secret protection related tools, such as GitHub Secret Scanning |
296296
| `users` | GitHub User related tools |
297+
| `gists` | GitHub Gist related tools |
298+
297299
<!-- END AUTOMATED TOOLSETS -->
298300

299301
## Tools
@@ -866,6 +868,7 @@ The following sets of tools are available (all are on by default):
866868

867869
</details>
868870

871+
869872
<details>
870873

871874
<summary>Users</summary>
@@ -878,6 +881,31 @@ The following sets of tools are available (all are on by default):
878881
- `sort`: Sort field by category (string, optional)
879882

880883
</details>
884+
<details>
885+
886+
<summary>Gists</summary>
887+
888+
- **list_gist** - List gists for a user
889+
- `username`: GitHub username (omit for authenticated user's gists) (string optional)
890+
- `since`: Only gists updated after this time (ISO 8601 timestamp) (string, required)
891+
- `page`: Page number (min 1) (number, optional)
892+
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
893+
894+
- **create_gist** - Create a new gist
895+
- `description`: Description of the gist (string, optional)
896+
- `filename`: Filename for gist file (string, required)
897+
- `content` : Content for gist file (string, required)
898+
- `public`: Whether the gist is public (boolean, default: false)
899+
900+
901+
- **update_gist** - Update an existing gist
902+
- `gist_id`: ID of the gist to update (string, required)
903+
- `description`: Description of the gist (string, optional)
904+
- `filename`: Filename for gist file (string, required)
905+
- `content` : Content for gist file (string, required)
906+
907+
</details>
908+
881909
<!-- END AUTOMATED TOOLS -->
882910

883911
### Additional Tools in Remote Github MCP Server
@@ -1048,4 +1076,4 @@ The exported Go API of this module should currently be considered unstable, and
10481076

10491077
## License
10501078

1051-
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
1079+
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)