Skip to content

Add support for managing users SSH key related operations #474

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,16 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
- **get_me** - Get details of the authenticated user
- No parameters required

- **list_users_public_ssh_keys** - "Lists the public SSH keys for the authenticated user's GitHub account
- No parameters required

- **get_users_public_ssh_key** - View extended details for a single public SSH key
- `key_id`: Key Id (number, required)

- **add_users_public_ssh_key** - Adds a public SSH key to the authenticated user's GitHub account
- `title`: Title of the key (string, optional)
- `key`: Public key contents (string, required)

### Issues

- **get_issue** - Gets the contents of an issue within a repository
Expand Down
3 changes: 3 additions & 0 deletions pkg/github/tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ func InitToolsets(passedToolsets []string, readOnly bool, getClient GetClientFn,
users := toolsets.NewToolset("users", "GitHub User related tools").
AddReadTools(
toolsets.NewServerTool(SearchUsers(getClient, t)),
toolsets.NewServerTool(ListUsersPublicSSHKeys(getClient, t)),
toolsets.NewServerTool(GetUsersPublicSSHKey(getClient, t)),
toolsets.NewServerTool(AddUsersPublicSSHKey(getClient, t)),
)
pullRequests := toolsets.NewToolset("pull_requests", "GitHub Pull Request related tools").
AddReadTools(
Expand Down
163 changes: 163 additions & 0 deletions pkg/github/user.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
package github

import (
"context"
"encoding/json"
"fmt"
"io"

"github.com/github/github-mcp-server/pkg/translations"
"github.com/google/go-github/v72/github"
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
)

// ListUsersPublicSSHKeys creates a tool to list public ssh keys for user
func ListUsersPublicSSHKeys(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
return mcp.NewTool("list_users_public_ssh_keys",
mcp.WithDescription(t("TOOL_LIST_USERS_PUBLIC_SSH_KEYS", "Lists the public SSH keys for the authenticated user's GitHub account")),
mcp.WithToolAnnotation(mcp.ToolAnnotation{
Title: t("TOOL_LIST_USERS_PUBLIC_SSH_KEYS_USER_TITLE", "List users public ssh keys"),
ReadOnlyHint: toBoolPtr(true),
}),
WithPagination(),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
pagination, err := OptionalPaginationParams(request)
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}

opts := &github.ListOptions{
Page: pagination.page,
PerPage: pagination.perPage,
}

client, err := getClient(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
}
result, resp, err := client.Users.ListKeys(ctx, "", opts)
if err != nil {
return nil, fmt.Errorf("failed to list users ssh keys: %w", err)
}
defer func() { _ = resp.Body.Close() }()

if resp.StatusCode != 200 {
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("failed to read response body: %w", err)
}
return mcp.NewToolResultError(fmt.Sprintf("failed to list users ssh keys: %s", string(body))), nil
}

r, err := json.Marshal(result)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}

return mcp.NewToolResultText(string(r)), nil
}
}

// GetUsersPublicSSHKey creates a tool to get public ssh key for user
func GetUsersPublicSSHKey(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
return mcp.NewTool("get_users_public_ssh_key",
mcp.WithDescription(t("TOOL_GET_USERS_PUBLIC_SSH_KEY", "View extended details for a single public SSH key")),
mcp.WithToolAnnotation(mcp.ToolAnnotation{
Title: t("TOOL_GET_USERS_PUBLIC_SSH_KEY_USER_TITLE", "Get public ssh key details"),
ReadOnlyHint: toBoolPtr(true),
}),
mcp.WithNumber("key_id",
mcp.Required(),
mcp.Description("The unique identifier of the key"),
),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
client, err := getClient(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
}
keyId, err := RequiredInt(request, "key_id")
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
result, resp, err := client.Users.GetKey(ctx, int64(keyId))
if err != nil {
return nil, fmt.Errorf("failed to get ssh key details: %w", err)
}
defer func() { _ = resp.Body.Close() }()

if resp.StatusCode != 200 {
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("failed to read response body: %w", err)
}
return mcp.NewToolResultError(fmt.Sprintf("failed to get ssh key details: %s", string(body))), nil
}

r, err := json.Marshal(result)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}

return mcp.NewToolResultText(string(r)), nil
}
}

// AddPublicSSHKey Adds a public SSH key to the authenticated user's GitHub account
func AddUsersPublicSSHKey(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
return mcp.NewTool("add_users_public_ssh_key",
mcp.WithDescription(t("TOOL_ADD_USERS_PUBLIC_SSH_KEY", "Adds a public SSH key to the authenticated user's GitHub account")),
mcp.WithToolAnnotation(mcp.ToolAnnotation{
Title: t("TOOL_ADD_USERS_PUBLIC_SSH_KEY_USER_TITLE", "Add users public ssh key"),
ReadOnlyHint: toBoolPtr(true),
}),
mcp.WithString("title",
mcp.Description("A descriptive name for the new key"),
),
mcp.WithString("key",
mcp.Required(),
mcp.Description("The public SSH key to add to your GitHub account"),
),
),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {

client, err := getClient(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get GitHub client: %w", err)
}
title, err := OptionalParam[string](request, "title")
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
key, err := requiredParam[string](request, "key")
if err != nil {
return mcp.NewToolResultError(err.Error()), nil
}
githubKey := &github.Key{
Title: &title,
Key: &key,
}
result, resp, err := client.Users.CreateKey(ctx, githubKey)
if err != nil {
return nil, fmt.Errorf("failed to add ssh key: %w", err)
}
defer func() { _ = resp.Body.Close() }()

if resp.StatusCode != 201 {
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("failed to read response body: %w", err)
}
return mcp.NewToolResultError(fmt.Sprintf("failed to add ssh key: %s", string(body))), nil
}

r, err := json.Marshal(result)
if err != nil {
return nil, fmt.Errorf("failed to marshal response: %w", err)
}

return mcp.NewToolResultText(string(r)), nil
}
}
Loading