Skip to content

Commit 8cdb89b

Browse files
committed
More uniform description text.
1 parent 784e8b1 commit 8cdb89b

File tree

7 files changed

+169
-169
lines changed

7 files changed

+169
-169
lines changed

pkg/github/code_scanning.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ func ListCodeScanningAlerts(getClient GetClientFn, t translations.TranslationHel
8686
mcp.Description("The Git reference for the results you want to list."),
8787
),
8888
mcp.WithString("state",
89-
mcp.Description("Filter code scanning alerts by state ('open', 'closed', 'dismissed', 'fixed'). Default: open"),
89+
mcp.Description("Filter code scanning alerts by state."),
9090
mcp.DefaultString("open"),
9191
mcp.Enum("open", "closed", "dismissed", "fixed"),
9292
),
9393
mcp.WithString("severity",
94-
mcp.Description("If provided, filter code scanning alerts by severity ('critical', 'high', 'medium', 'low', 'warning', 'note', 'error')"),
94+
mcp.Description("Filter code scanning alerts by severity."),
9595
mcp.Enum("critical", "high", "medium", "low", "warning", "note", "error"),
9696
),
9797
),

pkg/github/context_tools.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func GetMe(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mc
1717
return mcp.NewTool("get_me",
1818
mcp.WithDescription(t("TOOL_GET_ME_DESCRIPTION", "Get details of the authenticated GitHub user. Use this when a request include \"me\", \"my\"...")),
1919
mcp.WithString("reason",
20-
mcp.Description("Optional: reason the session was created"),
20+
mcp.Description("Optional: reason the session was created."),
2121
),
2222
),
2323
func(ctx context.Context, _ mcp.CallToolRequest) (*mcp.CallToolResult, error) {

pkg/github/dynamic_tools.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ func ToolsetEnum(toolsetGroup *toolsets.ToolsetGroup) mcp.PropertyOption {
2121

2222
func EnableToolset(s *server.MCPServer, toolsetGroup *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
2323
return mcp.NewTool("enable_toolset",
24-
mcp.WithDescription(t("TOOL_ENABLE_TOOLSET_DESCRIPTION", "Enable one of the sets of tools the GitHub MCP server provides, use get_toolset_tools and list_available_toolsets first to see what this will enable")),
24+
mcp.WithDescription(t("TOOL_ENABLE_TOOLSET_DESCRIPTION", "Enable one of the sets of tools the GitHub MCP server provides, use get_toolset_tools and list_available_toolsets first to see what this will enable.")),
2525
mcp.WithString("toolset",
2626
mcp.Required(),
27-
mcp.Description("The name of the toolset to enable"),
27+
mcp.Description("The name of the toolset to enable."),
2828
ToolsetEnum(toolsetGroup),
2929
),
3030
),
@@ -56,7 +56,7 @@ func EnableToolset(s *server.MCPServer, toolsetGroup *toolsets.ToolsetGroup, t t
5656

5757
func ListAvailableToolsets(toolsetGroup *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
5858
return mcp.NewTool("list_available_toolsets",
59-
mcp.WithDescription(t("TOOL_LIST_AVAILABLE_TOOLSETS_DESCRIPTION", "List all available toolsets this GitHub MCP server can offer, providing the enabled status of each. Use this when a task could be achieved with a GitHub tool and the currently available tools aren't enough. Call get_toolset_tools with these toolset names to discover specific tools you can call")),
59+
mcp.WithDescription(t("TOOL_LIST_AVAILABLE_TOOLSETS_DESCRIPTION", "List all available toolsets this GitHub MCP server can offer, providing the enabled status of each. Use this when a task could be achieved with a GitHub tool and the currently available tools aren't enough. Call get_toolset_tools with these toolset names to discover specific tools you can call.")),
6060
),
6161
func(_ context.Context, _ mcp.CallToolRequest) (*mcp.CallToolResult, error) {
6262
// We need to convert the toolsetGroup back to a map for JSON serialization
@@ -86,10 +86,10 @@ func ListAvailableToolsets(toolsetGroup *toolsets.ToolsetGroup, t translations.T
8686

8787
func GetToolsetsTools(toolsetGroup *toolsets.ToolsetGroup, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
8888
return mcp.NewTool("get_toolset_tools",
89-
mcp.WithDescription(t("TOOL_GET_TOOLSET_TOOLS_DESCRIPTION", "Lists all the capabilities that are enabled with the specified toolset, use this to get clarity on whether enabling a toolset would help you to complete a task")),
89+
mcp.WithDescription(t("TOOL_GET_TOOLSET_TOOLS_DESCRIPTION", "Lists all the capabilities that are enabled with the specified toolset, use this to get clarity on whether enabling a toolset would help you to complete a task.")),
9090
mcp.WithString("toolset",
9191
mcp.Required(),
92-
mcp.Description("The name of the toolset you want to get the tools for"),
92+
mcp.Description("The name of the toolset you want to get the tools for."),
9393
ToolsetEnum(toolsetGroup),
9494
),
9595
),

pkg/github/issues.go

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ import (
1717
// GetIssue creates a tool to get details of a specific issue in a GitHub repository.
1818
func GetIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
1919
return mcp.NewTool("get_issue",
20-
mcp.WithDescription(t("TOOL_GET_ISSUE_DESCRIPTION", "Get details of a specific issue in a GitHub repository")),
20+
mcp.WithDescription(t("TOOL_GET_ISSUE_DESCRIPTION", "Get details of a specific issue in a GitHub repository.")),
2121
mcp.WithString("owner",
2222
mcp.Required(),
23-
mcp.Description("The owner of the repository"),
23+
mcp.Description("The owner of the repository."),
2424
),
2525
mcp.WithString("repo",
2626
mcp.Required(),
27-
mcp.Description("The name of the repository"),
27+
mcp.Description("The name of the repository."),
2828
),
2929
mcp.WithNumber("issue_number",
3030
mcp.Required(),
31-
mcp.Description("The number of the issue"),
31+
mcp.Description("The number of the issue."),
3232
),
3333
),
3434
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -75,22 +75,22 @@ func GetIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool
7575
// AddIssueComment creates a tool to add a comment to an issue.
7676
func AddIssueComment(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
7777
return mcp.NewTool("add_issue_comment",
78-
mcp.WithDescription(t("TOOL_ADD_ISSUE_COMMENT_DESCRIPTION", "Add a comment to an existing issue")),
78+
mcp.WithDescription(t("TOOL_ADD_ISSUE_COMMENT_DESCRIPTION", "Add a comment to an existing issue.")),
7979
mcp.WithString("owner",
8080
mcp.Required(),
81-
mcp.Description("Repository owner"),
81+
mcp.Description("Repository owner."),
8282
),
8383
mcp.WithString("repo",
8484
mcp.Required(),
85-
mcp.Description("Repository name"),
85+
mcp.Description("Repository name."),
8686
),
8787
mcp.WithNumber("issue_number",
8888
mcp.Required(),
89-
mcp.Description("Issue number to comment on"),
89+
mcp.Description("Issue number to comment on."),
9090
),
9191
mcp.WithString("body",
9292
mcp.Required(),
93-
mcp.Description("Comment text"),
93+
mcp.Description("Comment content."),
9494
),
9595
),
9696
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -145,13 +145,13 @@ func AddIssueComment(getClient GetClientFn, t translations.TranslationHelperFunc
145145
// SearchIssues creates a tool to search for issues and pull requests.
146146
func SearchIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
147147
return mcp.NewTool("search_issues",
148-
mcp.WithDescription(t("TOOL_SEARCH_ISSUES_DESCRIPTION", "Search for issues and pull requests across GitHub repositories")),
148+
mcp.WithDescription(t("TOOL_SEARCH_ISSUES_DESCRIPTION", "Search for issues and pull requests across GitHub repositories.")),
149149
mcp.WithString("q",
150150
mcp.Required(),
151-
mcp.Description("Search query using GitHub issues search syntax"),
151+
mcp.Description("Search query using GitHub issues search syntax."),
152152
),
153153
mcp.WithString("sort",
154-
mcp.Description("Sort field (comments, reactions, created, etc.)"),
154+
mcp.Description("Sort results by number of matches of possible categories."),
155155
mcp.Enum(
156156
"comments",
157157
"reactions",
@@ -167,7 +167,7 @@ func SearchIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (
167167
),
168168
),
169169
mcp.WithString("order",
170-
mcp.Description("Sort order ('asc' or 'desc')"),
170+
mcp.Description("Sort order."),
171171
mcp.Enum("asc", "desc"),
172172
),
173173
WithPagination(),
@@ -229,40 +229,40 @@ func SearchIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (
229229
// CreateIssue creates a tool to create a new issue in a GitHub repository.
230230
func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
231231
return mcp.NewTool("create_issue",
232-
mcp.WithDescription(t("TOOL_CREATE_ISSUE_DESCRIPTION", "Create a new issue in a GitHub repository")),
232+
mcp.WithDescription(t("TOOL_CREATE_ISSUE_DESCRIPTION", "Create a new issue in a GitHub repository.")),
233233
mcp.WithString("owner",
234234
mcp.Required(),
235-
mcp.Description("Repository owner"),
235+
mcp.Description("Repository owner."),
236236
),
237237
mcp.WithString("repo",
238238
mcp.Required(),
239-
mcp.Description("Repository name"),
239+
mcp.Description("Repository name."),
240240
),
241241
mcp.WithString("title",
242242
mcp.Required(),
243-
mcp.Description("Issue title"),
243+
mcp.Description("Issue title."),
244244
),
245245
mcp.WithString("body",
246-
mcp.Description("Issue body content"),
246+
mcp.Description("Issue body content."),
247247
),
248248
mcp.WithArray("assignees",
249-
mcp.Description("Usernames to assign to this issue"),
249+
mcp.Description("Usernames to assign to this issue."),
250250
mcp.Items(
251251
map[string]interface{}{
252252
"type": "string",
253253
},
254254
),
255255
),
256256
mcp.WithArray("labels",
257-
mcp.Description("Labels to apply to this issue"),
257+
mcp.Description("Labels to apply to this issue."),
258258
mcp.Items(
259259
map[string]interface{}{
260260
"type": "string",
261261
},
262262
),
263263
),
264264
mcp.WithNumber("milestone",
265-
mcp.Description("Milestone number"),
265+
mcp.Description("Milestone number."),
266266
),
267267
),
268268
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -347,37 +347,37 @@ func CreateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
347347
// ListIssues creates a tool to list and filter repository issues
348348
func ListIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
349349
return mcp.NewTool("list_issues",
350-
mcp.WithDescription(t("TOOL_LIST_ISSUES_DESCRIPTION", "List issues in a GitHub repository with filtering options")),
350+
mcp.WithDescription(t("TOOL_LIST_ISSUES_DESCRIPTION", "List issues in a GitHub repository with filtering options.")),
351351
mcp.WithString("owner",
352352
mcp.Required(),
353-
mcp.Description("Repository owner"),
353+
mcp.Description("Repository owner."),
354354
),
355355
mcp.WithString("repo",
356356
mcp.Required(),
357-
mcp.Description("Repository name"),
357+
mcp.Description("Repository name."),
358358
),
359359
mcp.WithString("state",
360-
mcp.Description("Filter by state ('open', 'closed', 'all')"),
360+
mcp.Description("Filter by state."),
361361
mcp.Enum("open", "closed", "all"),
362362
),
363363
mcp.WithArray("labels",
364-
mcp.Description("Filter by labels"),
364+
mcp.Description("Filter by labels."),
365365
mcp.Items(
366366
map[string]interface{}{
367367
"type": "string",
368368
},
369369
),
370370
),
371371
mcp.WithString("sort",
372-
mcp.Description("Sort by ('created', 'updated', 'comments')"),
372+
mcp.Description("Sort order."),
373373
mcp.Enum("created", "updated", "comments"),
374374
),
375375
mcp.WithString("direction",
376-
mcp.Description("Sort direction ('asc', 'desc')"),
376+
mcp.Description("Sort direction"),
377377
mcp.Enum("asc", "desc"),
378378
),
379379
mcp.WithString("since",
380-
mcp.Description("Filter by date (ISO 8601 timestamp)"),
380+
mcp.Description("Filter by date (ISO 8601 timestamp)."),
381381
),
382382
WithPagination(),
383383
),
@@ -465,47 +465,47 @@ func ListIssues(getClient GetClientFn, t translations.TranslationHelperFunc) (to
465465
// UpdateIssue creates a tool to update an existing issue in a GitHub repository.
466466
func UpdateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
467467
return mcp.NewTool("update_issue",
468-
mcp.WithDescription(t("TOOL_UPDATE_ISSUE_DESCRIPTION", "Update an existing issue in a GitHub repository")),
468+
mcp.WithDescription(t("TOOL_UPDATE_ISSUE_DESCRIPTION", "Update an existing issue in a GitHub repository.")),
469469
mcp.WithString("owner",
470470
mcp.Required(),
471-
mcp.Description("Repository owner"),
471+
mcp.Description("Repository owner."),
472472
),
473473
mcp.WithString("repo",
474474
mcp.Required(),
475-
mcp.Description("Repository name"),
475+
mcp.Description("Repository name."),
476476
),
477477
mcp.WithNumber("issue_number",
478478
mcp.Required(),
479-
mcp.Description("Issue number to update"),
479+
mcp.Description("Issue number to update."),
480480
),
481481
mcp.WithString("title",
482-
mcp.Description("New title"),
482+
mcp.Description("New title."),
483483
),
484484
mcp.WithString("body",
485-
mcp.Description("New description"),
485+
mcp.Description("New description."),
486486
),
487487
mcp.WithString("state",
488-
mcp.Description("New state ('open' or 'closed')"),
488+
mcp.Description("New state."),
489489
mcp.Enum("open", "closed"),
490490
),
491491
mcp.WithArray("labels",
492-
mcp.Description("New labels"),
492+
mcp.Description("New labels."),
493493
mcp.Items(
494494
map[string]interface{}{
495495
"type": "string",
496496
},
497497
),
498498
),
499499
mcp.WithArray("assignees",
500-
mcp.Description("New assignees"),
500+
mcp.Description("New assignees."),
501501
mcp.Items(
502502
map[string]interface{}{
503503
"type": "string",
504504
},
505505
),
506506
),
507507
mcp.WithNumber("milestone",
508-
mcp.Description("New milestone number"),
508+
mcp.Description("New milestone number."),
509509
),
510510
),
511511
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
@@ -607,24 +607,24 @@ func UpdateIssue(getClient GetClientFn, t translations.TranslationHelperFunc) (t
607607
// GetIssueComments creates a tool to get comments for a GitHub issue.
608608
func GetIssueComments(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
609609
return mcp.NewTool("get_issue_comments",
610-
mcp.WithDescription(t("TOOL_GET_ISSUE_COMMENTS_DESCRIPTION", "Get comments for a GitHub issue")),
610+
mcp.WithDescription(t("TOOL_GET_ISSUE_COMMENTS_DESCRIPTION", "Get comments for a GitHub issue.")),
611611
mcp.WithString("owner",
612612
mcp.Required(),
613-
mcp.Description("Repository owner"),
613+
mcp.Description("Repository owner."),
614614
),
615615
mcp.WithString("repo",
616616
mcp.Required(),
617-
mcp.Description("Repository name"),
617+
mcp.Description("Repository name."),
618618
),
619619
mcp.WithNumber("issue_number",
620620
mcp.Required(),
621-
mcp.Description("Issue number"),
621+
mcp.Description("Issue number."),
622622
),
623623
mcp.WithNumber("page",
624-
mcp.Description("Page number"),
624+
mcp.Description("Page number."),
625625
),
626626
mcp.WithNumber("per_page",
627-
mcp.Description("Number of records per page"),
627+
mcp.Description("Number of records per page."),
628628
),
629629
),
630630
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy