Add get_project tool

Author: JoannaaKL

README.md

@@ -658,6 +658,11 @@ The following sets of tools are available (all are on by default):
 
 <summary>Projects</summary>
 
+- **get_project** - Get project
+  - `owner`: If owner_type == user it is the handle for the GitHub user account. If owner_type == organization it is the name of the organization. The name is not case sensitive. (string, required)
+  - `owner_type`: Owner type (string, required)
+  - `project_number`: The project's number (number, required)
+
 - **list_projects** - List projects
   - `after`: Cursor for items after (forward pagination) (string, optional)
   - `before`: Cursor for items before (backwards pagination) (string, optional)

pkg/github/__toolsnaps__/get_project.snap

@@ -0,0 +1,34 @@
+{
+  "annotations": {
+    "title": "Get project",
+    "readOnlyHint": true
+  },
+  "description": "Get Project for a user or organization",
+  "inputSchema": {
+    "properties": {
+      "owner": {
+        "description": "If owner_type == user it is the handle for the GitHub user account. If owner_type == organization it is the name of the organization. The name is not case sensitive.",
+        "type": "string"
+      },
+      "owner_type": {
+        "description": "Owner type",
+        "enum": [
+          "user",
+          "organization"
+        ],
+        "type": "string"
+      },
+      "project_number": {
+        "description": "The project's number",
+        "type": "number"
+      }
+    },
+    "required": [
+      "project_number",
+      "owner_type",
+      "owner"
+    ],
+    "type": "object"
+  },
+  "name": "get_project"
+}

pkg/github/projects.go

@@ -113,6 +113,75 @@ func ListProjects(getClient GetClientFn, t translations.TranslationHelperFunc) (
 		}
 }
 
+func GetProject(getClient GetClientFn, t translations.TranslationHelperFunc) (tool mcp.Tool, handler server.ToolHandlerFunc) {
+	return mcp.NewTool("get_project",
+			mcp.WithDescription(t("TOOL_GET_PROJECT_DESCRIPTION", "Get Project for a user or organization")),
+			mcp.WithToolAnnotation(mcp.ToolAnnotation{Title: t("TOOL_GET_PROJECT_USER_TITLE", "Get project"), ReadOnlyHint: ToBoolPtr(true)}),
+			mcp.WithNumber("project_number", mcp.Required(), mcp.Description("The project's number")),
+			mcp.WithString("owner_type", mcp.Required(), mcp.Description("Owner type"), mcp.Enum("user", "organization")),
+			mcp.WithString("owner", mcp.Required(), mcp.Description("If owner_type == user it is the handle for the GitHub user account. If owner_type == organization it is the name of the organization. The name is not case sensitive.")),
+		), func(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+
+			projectNumber, err := RequiredInt(req, "project_number")
+			if err != nil {
+				return mcp.NewToolResultError(err.Error()), nil
+			}
+
+			owner, err := RequiredParam[string](req, "owner")
+			if err != nil {
+				return mcp.NewToolResultError(err.Error()), nil
+			}
+
+			ownerType, err := RequiredParam[string](req, "owner_type")
+			if err != nil {
+				return mcp.NewToolResultError(err.Error()), nil
+			}
+
+			client, err := getClient(ctx)
+			if err != nil {
+				return mcp.NewToolResultError(err.Error()), nil
+			}
+
+			var url string
+			if ownerType == "organization" {
+				url = fmt.Sprintf("orgs/%s/projectsV2/%d", owner, projectNumber)
+			} else {
+				url = fmt.Sprintf("/users/%s/projectsV2/%d", owner, projectNumber)
+			}
+
+			projects := []github.ProjectV2{}
+
+			httpRequest, err := client.NewRequest("GET", url, nil)
+			if err != nil {
+				return nil, fmt.Errorf("failed to create request: %w", err)
+			}
+
+			resp, err := client.Do(ctx, httpRequest, &projects)
+			if err != nil {
+				return ghErrors.NewGitHubAPIErrorResponse(ctx,
+					"failed to get project",
+					resp,
+					err,
+				), nil
+			}
+			defer func() { _ = resp.Body.Close() }()
+
+			if resp.StatusCode != http.StatusOK {
+				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 project: %s", string(body))), nil
+			}
+			r, err := json.Marshal(projects)
+			if err != nil {
+				return nil, fmt.Errorf("failed to marshal response: %w", err)
+			}
+
+			return mcp.NewToolResultText(string(r)), nil
+		}
+}
+
 type ListProjectsOptions struct {
 	// A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
 	Before string `url:"before,omitempty"`

pkg/github/projects_test.go

@@ -166,3 +166,139 @@ func Test_ListProjects(t *testing.T) {
 		})
 	}
 }
+
+func Test_GetProject(t *testing.T) {
+	mockClient := gh.NewClient(nil)
+	tool, _ := GetProject(stubGetClientFn(mockClient), translations.NullTranslationHelper)
+	require.NoError(t, toolsnaps.Test(tool.Name, tool))
+
+	assert.Equal(t, "get_project", tool.Name)
+	assert.NotEmpty(t, tool.Description)
+	assert.Contains(t, tool.InputSchema.Properties, "project_number")
+	assert.Contains(t, tool.InputSchema.Properties, "owner")
+	assert.Contains(t, tool.InputSchema.Properties, "owner_type")
+	assert.ElementsMatch(t, tool.InputSchema.Required, []string{"project_number", "owner", "owner_type"})
+
+	// Minimal project object for response array
+	project := []map[string]any{{"id": 123, "title": "Project Title"}}
+
+	tests := []struct {
+		name           string
+		mockedClient   *http.Client
+		requestArgs    map[string]interface{}
+		expectError    bool
+		expectedLength int
+		expectedErrMsg string
+	}{
+		{
+			name: "success organization project fetch",
+			mockedClient: mock.NewMockedHTTPClient(
+				mock.WithRequestMatchHandler(
+					mock.EndpointPattern{Pattern: "/orgs/{org}/projectsV2/123", Method: http.MethodGet},
+					mockResponse(t, http.StatusOK, project),
+				),
+			),
+			requestArgs: map[string]interface{}{
+				"project_number": float64(123),
+				"owner":          "octo-org",
+				"owner_type":     "organization",
+			},
+			expectError:    false,
+			expectedLength: 1,
+		},
+		{
+			name: "success user project fetch",
+			mockedClient: mock.NewMockedHTTPClient(
+				mock.WithRequestMatchHandler(
+					mock.EndpointPattern{Pattern: "/users/{username}/projectsV2/456", Method: http.MethodGet},
+					mockResponse(t, http.StatusOK, project),
+				),
+			),
+			requestArgs: map[string]interface{}{
+				"project_number": float64(456),
+				"owner":          "octocat",
+				"owner_type":     "user",
+			},
+			expectError:    false,
+			expectedLength: 1,
+		},
+		{
+			name: "api error",
+			mockedClient: mock.NewMockedHTTPClient(
+				mock.WithRequestMatchHandler(
+					mock.EndpointPattern{Pattern: "/orgs/{org}/projectsV2/999", Method: http.MethodGet},
+					mockResponse(t, http.StatusInternalServerError, map[string]string{"message": "boom"}),
+				),
+			),
+			requestArgs: map[string]interface{}{
+				"project_number": float64(999),
+				"owner":          "octo-org",
+				"owner_type":     "organization",
+			},
+			expectError:    true,
+			expectedErrMsg: "failed to get project", // updated to match implementation
+		},
+		{
+			name:         "missing project_number",
+			mockedClient: mock.NewMockedHTTPClient(),
+			requestArgs: map[string]interface{}{
+				"owner":      "octo-org",
+				"owner_type": "organization",
+			},
+			expectError: true,
+		},
+		{
+			name:         "missing owner",
+			mockedClient: mock.NewMockedHTTPClient(),
+			requestArgs: map[string]interface{}{
+				"project_number": float64(123),
+				"owner_type":     "organization",
+			},
+			expectError: true,
+		},
+		{
+			name:         "missing owner_type",
+			mockedClient: mock.NewMockedHTTPClient(),
+			requestArgs: map[string]interface{}{
+				"project_number": float64(123),
+				"owner":          "octo-org",
+			},
+			expectError: true,
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			client := gh.NewClient(tc.mockedClient)
+			_, handler := GetProject(stubGetClientFn(client), translations.NullTranslationHelper)
+			request := createMCPRequest(tc.requestArgs)
+			result, err := handler(context.Background(), request)
+
+			require.NoError(t, err)
+			if tc.expectError {
+				require.True(t, result.IsError)
+				text := getTextResult(t, result).Text
+				if tc.expectedErrMsg != "" {
+					assert.Contains(t, text, tc.expectedErrMsg)
+				}
+				if tc.name == "missing project_number" {
+					assert.Contains(t, text, "missing required parameter: project_number")
+				}
+				if tc.name == "missing owner" {
+					assert.Contains(t, text, "missing required parameter: owner")
+				}
+				if tc.name == "missing owner_type" {
+					assert.Contains(t, text, "missing required parameter: owner_type")
+				}
+				return
+			}
+
+			require.False(t, result.IsError)
+			textContent := getTextResult(t, result)
+			var arr []map[string]any
+			err = json.Unmarshal([]byte(textContent.Text), &arr)
+			require.NoError(t, err)
+			assert.Equal(t, tc.expectedLength, len(arr))
+		})
+	}
+}

pkg/github/tools.go

@@ -193,6 +193,7 @@ func DefaultToolsetGroup(readOnly bool, getClient GetClientFn, getGQLClient GetG
 	projects := toolsets.NewToolset("projects", "GitHub Projects related tools").
 		AddReadTools(
 			toolsets.NewServerTool(ListProjects(getClient, t)),
+			toolsets.NewServerTool(GetProject(getClient, t)),
 		)
 
 	// Add toolsets to the group