Files
copilot-swe-agent[bot] aef9456766
License Check / license-check (push) Has been cancelled
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (actions) (push) Has been cancelled
Unit Tests / build (macos-latest) (push) Has been cancelled
Unit Tests / build (ubuntu-latest) (push) Has been cancelled
Unit Tests / build (windows-latest) (push) Has been cancelled
Lint / lint (push) Has been cancelled
Implement working completion support with custom in-process client
Co-authored-by: SamMorrowDrums <4811358+SamMorrowDrums@users.noreply.github.com>
2025-05-28 21:14:38 +00:00

315 lines
9.7 KiB
Go

package github
import (
"context"
"encoding/json"
"errors"
"fmt"
"github.com/google/go-github/v69/github"
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
)
// NewServer creates a new GitHub MCP server with the specified GH client and logger.
func NewServer(version string, opts ...server.ServerOption) *server.MCPServer {
// Add default options
defaultOpts := []server.ServerOption{
server.WithToolCapabilities(true),
server.WithResourceCapabilities(true, true),
server.WithLogging(),
}
opts = append(defaultOpts, opts...)
// Create a new MCP server
s := server.NewMCPServer(
"github-mcp-server",
version,
opts...,
)
return s
}
// GitHubMCPServer wraps the base MCP server to add completion support
type GitHubMCPServer struct {
*server.MCPServer
completionHandler CompletionHandlerFunc
}
// GetMCPServer returns the underlying MCP server for compatibility
func (s *GitHubMCPServer) GetMCPServer() *server.MCPServer {
return s.MCPServer
}
// GetCompletionHandler returns the completion handler
func (s *GitHubMCPServer) GetCompletionHandler() CompletionHandlerFunc {
return s.completionHandler
}
// NewGitHubServer creates a new GitHub MCP server with completion support
func NewGitHubServer(version string, getClient GetClientFn, opts ...server.ServerOption) *GitHubMCPServer {
baseServer := NewServer(version, opts...)
return &GitHubMCPServer{
MCPServer: baseServer,
completionHandler: RepositoryCompletionHandler(getClient),
}
}
// HandleMessage overrides the base HandleMessage to add completion support
func (s *GitHubMCPServer) HandleMessage(ctx context.Context, message json.RawMessage) mcp.JSONRPCMessage {
// Parse the message to check for completion requests
var baseMessage struct {
JSONRPC string `json:"jsonrpc"`
Method mcp.MCPMethod `json:"method"`
ID any `json:"id,omitempty"`
}
if err := json.Unmarshal(message, &baseMessage); err != nil {
return s.MCPServer.HandleMessage(ctx, message)
}
// Handle completion requests
if string(baseMessage.Method) == "completion/complete" {
return s.handleCompletion(ctx, baseMessage.ID, message)
}
// Delegate to base server for all other requests
return s.MCPServer.HandleMessage(ctx, message)
}
// handleCompletion processes completion requests
func (s *GitHubMCPServer) handleCompletion(ctx context.Context, id any, message json.RawMessage) mcp.JSONRPCMessage {
var request mcp.CompleteRequest
if err := json.Unmarshal(message, &request); err != nil {
return createErrorResponse(id, mcp.INVALID_REQUEST, "Failed to parse completion request")
}
result, err := s.completionHandler(ctx, request)
if err != nil {
return createErrorResponse(id, mcp.INTERNAL_ERROR, fmt.Sprintf("Completion failed: %v", err))
}
return createResponse(id, *result)
}
// Helper functions for JSON-RPC responses
func createErrorResponse(id any, code int, message string) mcp.JSONRPCMessage {
return mcp.JSONRPCError{
JSONRPC: mcp.JSONRPC_VERSION,
ID: mcp.NewRequestId(id),
Error: struct {
Code int `json:"code"`
Message string `json:"message"`
Data any `json:"data,omitempty"`
}{
Code: code,
Message: message,
},
}
}
func createResponse(id any, result any) mcp.JSONRPCMessage {
return mcp.JSONRPCResponse{
JSONRPC: mcp.JSONRPC_VERSION,
ID: mcp.NewRequestId(id),
Result: result,
}
}
// OptionalParamOK is a helper function that can be used to fetch a requested parameter from the request.
// It returns the value, a boolean indicating if the parameter was present, and an error if the type is wrong.
func OptionalParamOK[T any](r mcp.CallToolRequest, p string) (value T, ok bool, err error) {
// Check if the parameter is present in the request
val, exists := r.GetArguments()[p]
if !exists {
// Not present, return zero value, false, no error
return
}
// Check if the parameter is of the expected type
value, ok = val.(T)
if !ok {
// Present but wrong type
err = fmt.Errorf("parameter %s is not of type %T, is %T", p, value, val)
ok = true // Set ok to true because the parameter *was* present, even if wrong type
return
}
// Present and correct type
ok = true
return
}
// isAcceptedError checks if the error is an accepted error.
func isAcceptedError(err error) bool {
var acceptedError *github.AcceptedError
return errors.As(err, &acceptedError)
}
// requiredParam is a helper function that can be used to fetch a requested parameter from the request.
// It does the following checks:
// 1. Checks if the parameter is present in the request.
// 2. Checks if the parameter is of the expected type.
// 3. Checks if the parameter is not empty, i.e: non-zero value
func requiredParam[T comparable](r mcp.CallToolRequest, p string) (T, error) {
var zero T
// Check if the parameter is present in the request
if _, ok := r.GetArguments()[p]; !ok {
return zero, fmt.Errorf("missing required parameter: %s", p)
}
// Check if the parameter is of the expected type
if _, ok := r.GetArguments()[p].(T); !ok {
return zero, fmt.Errorf("parameter %s is not of type %T", p, zero)
}
if r.GetArguments()[p].(T) == zero {
return zero, fmt.Errorf("missing required parameter: %s", p)
}
return r.GetArguments()[p].(T), nil
}
// RequiredInt is a helper function that can be used to fetch a requested parameter from the request.
// It does the following checks:
// 1. Checks if the parameter is present in the request.
// 2. Checks if the parameter is of the expected type.
// 3. Checks if the parameter is not empty, i.e: non-zero value
func RequiredInt(r mcp.CallToolRequest, p string) (int, error) {
v, err := requiredParam[float64](r, p)
if err != nil {
return 0, err
}
return int(v), nil
}
// OptionalParam is a helper function that can be used to fetch a requested parameter from the request.
// It does the following checks:
// 1. Checks if the parameter is present in the request, if not, it returns its zero-value
// 2. If it is present, it checks if the parameter is of the expected type and returns it
func OptionalParam[T any](r mcp.CallToolRequest, p string) (T, error) {
var zero T
// Check if the parameter is present in the request
if _, ok := r.GetArguments()[p]; !ok {
return zero, nil
}
// Check if the parameter is of the expected type
if _, ok := r.GetArguments()[p].(T); !ok {
return zero, fmt.Errorf("parameter %s is not of type %T, is %T", p, zero, r.GetArguments()[p])
}
return r.GetArguments()[p].(T), nil
}
// OptionalIntParam is a helper function that can be used to fetch a requested parameter from the request.
// It does the following checks:
// 1. Checks if the parameter is present in the request, if not, it returns its zero-value
// 2. If it is present, it checks if the parameter is of the expected type and returns it
func OptionalIntParam(r mcp.CallToolRequest, p string) (int, error) {
v, err := OptionalParam[float64](r, p)
if err != nil {
return 0, err
}
return int(v), nil
}
// OptionalIntParamWithDefault is a helper function that can be used to fetch a requested parameter from the request
// similar to optionalIntParam, but it also takes a default value.
func OptionalIntParamWithDefault(r mcp.CallToolRequest, p string, d int) (int, error) {
v, err := OptionalIntParam(r, p)
if err != nil {
return 0, err
}
if v == 0 {
return d, nil
}
return v, nil
}
// OptionalStringArrayParam is a helper function that can be used to fetch a requested parameter from the request.
// It does the following checks:
// 1. Checks if the parameter is present in the request, if not, it returns its zero-value
// 2. If it is present, iterates the elements and checks each is a string
func OptionalStringArrayParam(r mcp.CallToolRequest, p string) ([]string, error) {
// Check if the parameter is present in the request
if _, ok := r.GetArguments()[p]; !ok {
return []string{}, nil
}
switch v := r.GetArguments()[p].(type) {
case nil:
return []string{}, nil
case []string:
return v, nil
case []any:
strSlice := make([]string, len(v))
for i, v := range v {
s, ok := v.(string)
if !ok {
return []string{}, fmt.Errorf("parameter %s is not of type string, is %T", p, v)
}
strSlice[i] = s
}
return strSlice, nil
default:
return []string{}, fmt.Errorf("parameter %s could not be coerced to []string, is %T", p, r.GetArguments()[p])
}
}
// WithPagination returns a ToolOption that adds "page" and "perPage" parameters to the tool.
// The "page" parameter is optional, min 1. The "perPage" parameter is optional, min 1, max 100.
func WithPagination() mcp.ToolOption {
return func(tool *mcp.Tool) {
mcp.WithNumber("page",
mcp.Description("Page number for pagination (min 1)"),
mcp.Min(1),
)(tool)
mcp.WithNumber("perPage",
mcp.Description("Results per page for pagination (min 1, max 100)"),
mcp.Min(1),
mcp.Max(100),
)(tool)
}
}
type PaginationParams struct {
page int
perPage int
}
// OptionalPaginationParams returns the "page" and "perPage" parameters from the request,
// or their default values if not present, "page" default is 1, "perPage" default is 30.
// In future, we may want to make the default values configurable, or even have this
// function returned from `withPagination`, where the defaults are provided alongside
// the min/max values.
func OptionalPaginationParams(r mcp.CallToolRequest) (PaginationParams, error) {
page, err := OptionalIntParamWithDefault(r, "page", 1)
if err != nil {
return PaginationParams{}, err
}
perPage, err := OptionalIntParamWithDefault(r, "perPage", 30)
if err != nil {
return PaginationParams{}, err
}
return PaginationParams{
page: page,
perPage: perPage,
}, nil
}
func MarshalledTextResult(v any) *mcp.CallToolResult {
data, err := json.Marshal(v)
if err != nil {
return mcp.NewToolResultErrorFromErr("failed to marshal text result to json", err)
}
return mcp.NewToolResultText(string(data))
}