- Notifications
You must be signed in to change notification settings - Fork939
Add "organizations" tool#347
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
riseandignite wants to merge1 commit intogithub:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+359 −8
Open
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package github | ||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "github.com/github/github-mcp-server/pkg/translations" | ||
| "github.com/google/go-github/v69/github" | ||
| "github.com/mark3labs/mcp-go/mcp" | ||
| "github.com/mark3labs/mcp-go/server" | ||
| ) | ||
| // ListOrganizations creates a tool to list organizations a user is part of. | ||
| func ListOrganizations(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) { | ||
| return mcp.NewTool("list_organizations", | ||
| mcp.WithDescription(t("TOOL_LIST_ORGANIZATIONS_DESCRIPTION", "List organizations the authenticated user is a member of")), | ||
| mcp.WithToolAnnotation(mcp.ToolAnnotation{ | ||
| Title: t("TOOL_LIST_ORGANIZATIONS_USER_TITLE", "List organizations"), | ||
| ReadOnlyHint: 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) | ||
| } | ||
| // Call the GitHub API to list orgs | ||
| orgs, resp, err := client.Organizations.List(ctx, "", opts) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to list organizations: %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 organizations: %s", string(body))), nil | ||
| } | ||
| r, err := json.Marshal(orgs) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to marshal response: %w", err) | ||
| } | ||
| return mcp.NewToolResultText(string(r)), nil | ||
| } | ||
| } | ||
| // GetOrganization creates a tool to get details for a specific organization. | ||
| func GetOrganization(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) { | ||
| return mcp.NewTool("get_organization", | ||
| mcp.WithDescription(t("TOOL_GET_ORGANIZATION_DESCRIPTION", "Get information about an organization")), | ||
| mcp.WithToolAnnotation(mcp.ToolAnnotation{ | ||
| Title: t("TOOL_GET_ORGANIZATION_USER_TITLE", "Get organization"), | ||
| ReadOnlyHint: true, | ||
| }), | ||
| mcp.WithString("org", | ||
| mcp.Required(), | ||
| mcp.Description("Organization name"), | ||
| ), | ||
| ), | ||
| func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) { | ||
| orgName, err := requiredParam[string](request, "org") | ||
| if err != nil { | ||
| return mcp.NewToolResultError(err.Error()), nil | ||
| } | ||
| client, err := getClient(ctx) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get GitHub client: %w", err) | ||
| } | ||
| // Call the GitHub API to get org details | ||
| org, resp, err := client.Organizations.Get(ctx, orgName) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get organization: %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 organization: %s", string(body))), nil | ||
| } | ||
| r, err := json.Marshal(org) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to marshal response: %w", err) | ||
| } | ||
| return mcp.NewToolResultText(string(r)), nil | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| package github | ||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "net/http" | ||
| "testing" | ||
| "github.com/github/github-mcp-server/pkg/translations" | ||
| "github.com/google/go-github/v69/github" | ||
| "github.com/migueleliasweb/go-github-mock/src/mock" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
| func Test_ListOrganizations(t *testing.T) { | ||
| // Verify tool definition once | ||
| mockClient := github.NewClient(nil) | ||
| tool, _ := ListOrganizations(stubGetClientFn(mockClient), translations.NullTranslationHelper) | ||
| assert.Equal(t, "list_organizations", tool.Name) | ||
| assert.NotEmpty(t, tool.Description) | ||
| assert.Contains(t, tool.InputSchema.Properties, "page") | ||
| assert.Contains(t, tool.InputSchema.Properties, "perPage") | ||
| // Setup mock orgs for success case | ||
| mockOrgs := []*github.Organization{ | ||
| { | ||
| Login: github.Ptr("org1"), | ||
| NodeID: github.Ptr("node1"), | ||
| AvatarURL: github.Ptr("https://github.com/images/org1.png"), | ||
| HTMLURL: github.Ptr("https://github.com/org1"), | ||
| }, | ||
| { | ||
| Login: github.Ptr("org2"), | ||
| NodeID: github.Ptr("node2"), | ||
| AvatarURL: github.Ptr("https://github.com/images/org2.png"), | ||
| HTMLURL: github.Ptr("https://github.com/org2"), | ||
| }, | ||
| } | ||
| tests := []struct { | ||
| name string | ||
| mockedClient *http.Client | ||
| requestArgs map[string]interface{} | ||
| expectError bool | ||
| expectedOrgs []*github.Organization | ||
| expectedErrMsg string | ||
| }{ | ||
| { | ||
| name: "successful orgs fetch", | ||
| mockedClient: mock.NewMockedHTTPClient( | ||
| mock.WithRequestMatch( | ||
| mock.GetUserOrgs, | ||
| mockOrgs, | ||
| ), | ||
| ), | ||
| requestArgs: map[string]interface{}{ | ||
| "page": float64(1), | ||
| "perPage": float64(10), | ||
| }, | ||
| expectError: false, | ||
| expectedOrgs: mockOrgs, | ||
| }, | ||
| { | ||
| name: "orgs fetch fails", | ||
| mockedClient: mock.NewMockedHTTPClient( | ||
| mock.WithRequestMatchHandler( | ||
| mock.GetUserOrgs, | ||
| http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusUnauthorized) | ||
| _, _ = w.Write([]byte(`{"message": "Unauthorized"}`)) | ||
| }), | ||
| ), | ||
| ), | ||
| requestArgs: map[string]interface{}{ | ||
| "page": float64(1), | ||
| "perPage": float64(10), | ||
| }, | ||
| expectError: true, | ||
| expectedErrMsg: "failed to list organizations", | ||
| }, | ||
| } | ||
| for _, tc := range tests { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| // Setup client with mock | ||
| client := github.NewClient(tc.mockedClient) | ||
| _, handler := ListOrganizations(stubGetClientFn(client), translations.NullTranslationHelper) | ||
| // Create call request | ||
| request := createMCPRequest(tc.requestArgs) | ||
| // Call handler | ||
| result, err := handler(context.Background(), request) | ||
| // Verify results | ||
| if tc.expectError { | ||
| require.Error(t, err) | ||
| assert.Contains(t, err.Error(), tc.expectedErrMsg) | ||
| return | ||
| } | ||
| require.NoError(t, err) | ||
| // Parse the result and get the text content if no error | ||
| textContent := getTextResult(t, result) | ||
| // Unmarshal and verify the result | ||
| var returnedOrgs []*github.Organization | ||
| err = json.Unmarshal([]byte(textContent.Text), &returnedOrgs) | ||
| require.NoError(t, err) | ||
| require.Equal(t, len(tc.expectedOrgs), len(returnedOrgs)) | ||
| for i, expectedOrg := range tc.expectedOrgs { | ||
| assert.Equal(t, *expectedOrg.Login, *returnedOrgs[i].Login) | ||
| assert.Equal(t, *expectedOrg.NodeID, *returnedOrgs[i].NodeID) | ||
| assert.Equal(t, *expectedOrg.HTMLURL, *returnedOrgs[i].HTMLURL) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
| func Test_GetOrganization(t *testing.T) { | ||
| // Verify tool definition once | ||
| mockClient := github.NewClient(nil) | ||
| tool, _ := GetOrganization(stubGetClientFn(mockClient), translations.NullTranslationHelper) | ||
| assert.Equal(t, "get_organization", tool.Name) | ||
| assert.NotEmpty(t, tool.Description) | ||
| assert.Contains(t, tool.InputSchema.Properties, "org") | ||
| assert.ElementsMatch(t, tool.InputSchema.Required, []string{"org"}) | ||
| // Setup mock org for success case | ||
| mockOrg := &github.Organization{ | ||
| Login: github.Ptr("testorg"), | ||
| NodeID: github.Ptr("node123"), | ||
| Name: github.Ptr("Test Organization"), | ||
| Description: github.Ptr("This is a test organization"), | ||
| AvatarURL: github.Ptr("https://github.com/images/testorg.png"), | ||
| HTMLURL: github.Ptr("https://github.com/testorg"), | ||
| Location: github.Ptr("San Francisco"), | ||
| Blog: github.Ptr("https://testorg.com"), | ||
| Email: github.Ptr("info@testorg.com"), | ||
| } | ||
| tests := []struct { | ||
| name string | ||
| mockedClient *http.Client | ||
| requestArgs map[string]interface{} | ||
| expectError bool | ||
| expectedOrg *github.Organization | ||
| expectedErrMsg string | ||
| }{ | ||
| { | ||
| name: "successful org fetch", | ||
| mockedClient: mock.NewMockedHTTPClient( | ||
| mock.WithRequestMatch( | ||
| mock.GetOrgsByOrg, | ||
| mockOrg, | ||
| ), | ||
| ), | ||
| requestArgs: map[string]interface{}{ | ||
| "org": "testorg", | ||
| }, | ||
| expectError: false, | ||
| expectedOrg: mockOrg, | ||
| }, | ||
| { | ||
| name: "org fetch fails", | ||
| mockedClient: mock.NewMockedHTTPClient( | ||
| mock.WithRequestMatchHandler( | ||
| mock.GetOrgsByOrg, | ||
| http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusNotFound) | ||
| _, _ = w.Write([]byte(`{"message": "Not Found"}`)) | ||
| }), | ||
| ), | ||
| ), | ||
| requestArgs: map[string]interface{}{ | ||
| "org": "nonexistentorg", | ||
| }, | ||
| expectError: true, | ||
| expectedErrMsg: "failed to get organization", | ||
| }, | ||
| } | ||
| for _, tc := range tests { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| // Setup client with mock | ||
| client := github.NewClient(tc.mockedClient) | ||
| _, handler := GetOrganization(stubGetClientFn(client), translations.NullTranslationHelper) | ||
| // Create call request | ||
| request := createMCPRequest(tc.requestArgs) | ||
| // Call handler | ||
| result, err := handler(context.Background(), request) | ||
| // Verify results | ||
| if tc.expectError { | ||
| require.Error(t, err) | ||
| assert.Contains(t, err.Error(), tc.expectedErrMsg) | ||
| return | ||
| } | ||
| require.NoError(t, err) | ||
| // Parse the result and get the text content if no error | ||
| textContent := getTextResult(t, result) | ||
| // Unmarshal and verify the result | ||
| var returnedOrg github.Organization | ||
| err = json.Unmarshal([]byte(textContent.Text), &returnedOrg) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, *tc.expectedOrg.Login, *returnedOrg.Login) | ||
| assert.Equal(t, *tc.expectedOrg.Name, *returnedOrg.Name) | ||
| assert.Equal(t, *tc.expectedOrg.Description, *returnedOrg.Description) | ||
| assert.Equal(t, *tc.expectedOrg.HTMLURL, *returnedOrg.HTMLURL) | ||
| }) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.