Skip to content

Update list_commits Filtering Descriptions #634

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.

Sign up for GitHub

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 6 commits into from
Jul 7, 2025
+12 −10
Merged

Update list_commits Filtering Descriptions #634

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
29f641d
update sha arg description for list_commits, get_file_contents
LuluBeatson Jul 3, 2025
b1da114
update perPage description for pagination to inform of default 30
LuluBeatson Jul 3, 2025
26322aa
toolsnaps, docs
LuluBeatson Jul 3, 2025
3472483
Merge remote-tracking branch 'origin/main' into lulu/tool-descriptions
LuluBeatson Jul 7, 2025
5963ed8
Merge remote-tracking branch 'origin/main' into lulu/tool-descriptions
LuluBeatson Jul 7, 2025
0fbb923
revert perPage description
LuluBeatson Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,14 +479,14 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `filter`: Filters jobs by their completed_at timestamp (string, optional)
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `run_id`: The unique identifier of the workflow run (number, required)

- **list_workflow_run_artifacts** - List workflow artifacts
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `run_id`: The unique identifier of the workflow run (number, required)

Expand All @@ -496,15 +496,15 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `event`: Returns workflow runs for a specific event type (string, optional)
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `status`: Returns workflow runs with the check run status (string, optional)
- `workflow_id`: The workflow ID or workflow file name (string, required)

- **list_workflows** - List workflows
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)

- **rerun_failed_jobs** - Rerun failed jobs
Expand Down Expand Up @@ -633,15 +633,15 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `issue_number`: Issue number (number, required)
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)

- **list_issues** - List issues
- `direction`: Sort direction (string, optional)
- `labels`: Filter by labels (string[], optional)
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `since`: Filter by date (ISO 8601 timestamp) (string, optional)
- `sort`: Sort order (string, optional)
Expand All @@ -651,7 +651,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `order`: Sort order (string, optional)
- `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `query`: Search query using GitHub issues search syntax (string, required)
- `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
- `sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
Expand Down Expand Up @@ -685,7 +685,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `filter`: Filter notifications to, use default unless specified. Read notifications are ones that have already been acknowledged by the user. Participating notifications are those that the user is directly involved in, such as issues or pull requests they have commented on or created. (string, optional)
- `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
- `since`: Only show notifications updated after the given time (ISO 8601 format) (string, optional)

Expand All @@ -712,7 +712,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **search_orgs** - Search organizations
- `order`: Sort order (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `query`: Search query using GitHub organizations search syntax scoped to type:org (string, required)
- `sort`: Sort field by category (string, optional)

Expand Down Expand Up @@ -781,7 +781,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **get_pull_request_files** - Get pull request files
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `pullNumber`: Pull request number (number, required)
- `repo`: Repository name (string, required)

Expand All @@ -801,7 +801,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `head`: Filter by head user/org and branch (string, optional)
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `sort`: Sort by (string, optional)
- `state`: Filter by state (string, optional)
Expand All @@ -823,7 +823,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `order`: Sort order (string, optional)
- `owner`: Optional repository owner. If provided with repo, only notifications for this repository are listed. (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `query`: Search query using GitHub pull request search syntax (string, required)
- `repo`: Optional repository name. If provided with owner, only notifications for this repository are listed. (string, optional)
- `sort`: Sort field by number of matches of categories, defaults to best match (string, optional)
Expand Down Expand Up @@ -893,7 +893,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **get_commit** - Get commit details
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `sha`: Commit SHA, branch name, or tag name (string, required)

Expand All @@ -902,7 +902,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- `path`: Path to file/directory (directories must end with a slash '/') (string, required)
- `ref`: Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head` (string, optional)
- `repo`: Repository name (string, required)
- `sha`: Accepts optional git sha, if sha is specified it will be used instead of ref (string, optional)
- `sha`: Accepts optional commit SHA. If specified, it will be used instead of ref (string, optional)

- **get_tag** - Get tag details
- `owner`: Repository owner (string, required)
Expand All @@ -912,21 +912,21 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **list_branches** - List branches
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)

- **list_commits** - List commits
- `author`: Author username or email address (string, optional)
- `author`: Author username or email address to filter commits by (string, optional)
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)
- `sha`: The commit SHA, branch name, or tag name to list commits from. If not specified, defaults to the repository's default branch. (string, optional)
- `sha`: Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA. (string, optional)

- **list_tags** - List tags
- `owner`: Repository owner (string, required)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `repo`: Repository name (string, required)

- **push_files** - Push files to repository
Expand All @@ -939,13 +939,13 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **search_code** - Search code
- `order`: Sort order (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `q`: Search query using GitHub code search syntax (string, required)
- `sort`: Sort field ('indexed' only) (string, optional)

- **search_repositories** - Search repositories
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `query`: Search query (string, required)

</details>
Expand Down Expand Up @@ -975,7 +975,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **search_users** - Search users
- `order`: Sort order (string, optional)
- `page`: Page number for pagination (min 1) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100) (number, optional)
- `perPage`: Results per page for pagination (min 1, max 100). If unset, defaults to 30. (number, optional)
- `query`: Search query using GitHub users search syntax scoped to type:user (string, required)
- `sort`: Sort field by category (string, optional)

Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/get_commit.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/get_file_contents.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"type": "string"
},
"sha": {
"description": "Accepts optional git sha, if sha is specified it will be used instead of ref",
"description": "Accepts optional commit SHA. If specified, it will be used instead of ref",
"type": "string"
}
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/get_issue_comments.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/get_pull_request_files.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/list_branches.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
6 changes: 3 additions & 3 deletions pkg/github/__toolsnaps__/list_commits.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"inputSchema": {
"properties": {
"author": {
"description": "Author username or email address",
"description": "Author username or email address to filter commits by",
"type": "string"
},
"owner": {
Expand All @@ -20,7 +20,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand All @@ -30,7 +30,7 @@
"type": "string"
},
"sha": {
"description": "The commit SHA, branch name, or tag name to list commits from. If not specified, defaults to the repository's default branch.",
"description": "Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA.",
"type": "string"
}
},
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/list_issues.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/list_notifications.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/list_pull_requests.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/list_tags.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/search_code.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/search_issues.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/search_pull_requests.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/search_repositories.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
2 changes: 1 addition & 1 deletion pkg/github/__toolsnaps__/search_users.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"type": "number"
},
"perPage": {
"description": "Results per page for pagination (min 1, max 100)",
"description": "Results per page for pagination (min 1, max 100). If unset, defaults to 30.",
"maximum": 100,
"minimum": 1,
"type": "number"
Expand Down
6 changes: 3 additions & 3 deletions pkg/github/repositories.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ func ListCommits(getClient GetClientFn, t translations.TranslationHelperFunc) (t
mcp.Description("Repository name"),
),
mcp.WithString("sha",
mcp.Description("The commit SHA, branch name, or tag name to list commits from. If not specified, defaults to the repository's default branch."),
mcp.Description("Commit SHA, branch or tag name to list commits of. If not provided, uses the default branch of the repository. If a commit SHA is provided, will list commits up to that SHA."),
),
mcp.WithString("author",
mcp.Description("Author username or email address"),
mcp.Description("Author username or email address to filter commits by"),
),
WithPagination(),
),
Expand Down Expand Up @@ -470,7 +470,7 @@ func GetFileContents(getClient GetClientFn, getRawClient raw.GetRawClientFn, t t
mcp.Description("Accepts optional git refs such as `refs/tags/{tag}`, `refs/heads/{branch}` or `refs/pull/{pr_number}/head`"),
),
mcp.WithString("sha",
mcp.Description("Accepts optional git sha, if sha is specified it will be used instead of ref"),
mcp.Description("Accepts optional commit SHA. If specified, it will be used instead of ref"),
),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
Expand Down
Loading