Skip to content

Add missing tool descriptions #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 16, 2025
Merged

Add missing tool descriptions #515

merged 2 commits into from
Jun 16, 2025

Conversation

tonytrg
Copy link
Contributor

@tonytrg tonytrg commented Jun 13, 2025

This pull request adds missing descriptions for several tools in the codebase. The changes improve code clarity and maintainability by ensuring that each tool is properly documented. Please review the updates and let me know if further adjustments are needed.

@Copilot Copilot AI review requested due to automatic review settings June 13, 2025 15:51
@tonytrg tonytrg requested a review from a team as a code owner June 13, 2025 15:51
@tonytrg
Copy link
Contributor Author

tonytrg commented Jun 13, 2025

Good job mcp!

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds missing descriptions for various GitHub tools in the README to improve clarity and maintainability.

  • Introduces documentation for new and existing tools related to issues, pull request reviews, file operations, and tags.
  • Ensures each tool lists required parameters with types and enums where applicable.
  • Cleans up structure under the “Pull Requests” and other sections.
Comments suppressed due to low confidence (3)

README.md:685

  • Remove this stray list marker (-) with no content to prevent an unintended blank bullet in the rendered documentation.
-

README.md:538

  • Standardize enum formatting for the event parameter under submit_pending_pull_request_review by using a separate bullet with consistent quoting and backticks around Enum:.
-   Enum: "APPROVE", "REQUEST_CHANGES", "COMMENT"

README.md:553

  • For create_and_submit_pull_request_review, move the allowed values into a separate - Enum: ... bullet and switch to double quotes to align with the rest of the documentation.
- `event`: Review action ('APPROVE', 'REQUEST_CHANGES', 'COMMENT') (string, required)

Copy link
Collaborator

@SamMorrowDrums SamMorrowDrums left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, laziness here was mostly because we were going to begin generating these.

@tonytrg
Copy link
Contributor Author

tonytrg commented Jun 13, 2025

I was thinking about a script that autogenerates this because its not sustainable lol.

let me cross check it first, its super ai generated. From start to finish even the pr creation.

@tonytrg tonytrg merged commit cdab131 into main Jun 16, 2025
15 of 16 checks passed
@tonytrg tonytrg deleted the tonytrg/update-readme branch June 16, 2025 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants