mcp: implement completion (#55)
This CL implements a completion handler for the server and a complete method for the client. Fixes: #12 <!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> This adds support for completion. ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> Added tests and an example. ## Breaking Changes <!-- Will users need to update their code or configurations? --> N/A ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [x] I have added appropriate error handling - [x] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions -->
This commit is contained in:
Sam Thanawalla
GitHub
parent
92b6983c1c
commit
e1b1cd0072
1 changed files with 579 additions and 5 deletions
|
|
@ -70,6 +70,423 @@ func TestParamsMeta(t *testing.T) {
|
|||
p.SetProgressToken(int64(1))
|
||||
}
|
||||
|
||||
func TestCompleteReference(t *testing.T) {
|
||||
marshalTests := []struct {
|
||||
name string
|
||||
in CompleteReference // The Go struct to marshal
|
||||
want string // The expected JSON string output
|
||||
wantErr bool // True if json.Marshal is expected to return an error
|
||||
}{
|
||||
{
|
||||
name: "ValidPrompt",
|
||||
in: CompleteReference{Type: "ref/prompt", Name: "my_prompt"},
|
||||
want: `{"type":"ref/prompt","name":"my_prompt"}`,
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "ValidResource",
|
||||
in: CompleteReference{Type: "ref/resource", URI: "file:///path/to/resource.txt"},
|
||||
want: `{"type":"ref/resource","uri":"file:///path/to/resource.txt"}`,
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "ValidPromptEmptyName",
|
||||
in: CompleteReference{Type: "ref/prompt", Name: ""},
|
||||
want: `{"type":"ref/prompt"}`,
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "ValidResourceEmptyURI",
|
||||
in: CompleteReference{Type: "ref/resource", URI: ""},
|
||||
want: `{"type":"ref/resource"}`,
|
||||
wantErr: false,
|
||||
},
|
||||
// Error cases for MarshalJSON
|
||||
{
|
||||
name: "InvalidType",
|
||||
in: CompleteReference{Type: "ref/unknown", Name: "something"},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "PromptWithURI",
|
||||
in: CompleteReference{Type: "ref/prompt", Name: "my_prompt", URI: "unexpected_uri"},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "ResourceWithName",
|
||||
in: CompleteReference{Type: "ref/resource", URI: "my_uri", Name: "unexpected_name"},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "MissingTypeField",
|
||||
in: CompleteReference{Name: "missing"}, // Type is ""
|
||||
wantErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
// Define test cases specifically for Unmarshalling
|
||||
unmarshalTests := []struct {
|
||||
name string
|
||||
in string // The JSON string input
|
||||
want CompleteReference // The expected Go struct output
|
||||
wantErr bool // True if json.Unmarshal is expected to return an error
|
||||
}{
|
||||
{
|
||||
name: "ValidPrompt",
|
||||
in: `{"type":"ref/prompt","name":"my_prompt"}`,
|
||||
want: CompleteReference{Type: "ref/prompt", Name: "my_prompt"},
|
||||
wantErr: false,
|
||||
},
|
||||
{
|
||||
name: "ValidResource",
|
||||
in: `{"type":"ref/resource","uri":"file:///path/to/resource.txt"}`,
|
||||
want: CompleteReference{Type: "ref/resource", URI: "file:///path/to/resource.txt"},
|
||||
wantErr: false,
|
||||
},
|
||||
// Error cases for UnmarshalJSON
|
||||
{
|
||||
name: "UnrecognizedType",
|
||||
in: `{"type":"ref/unknown","name":"something"}`,
|
||||
want: CompleteReference{}, // placeholder, as unmarshal will fail
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "PromptWithURI",
|
||||
in: `{"type":"ref/prompt","name":"my_prompt","uri":"unexpected_uri"}`,
|
||||
want: CompleteReference{}, // placeholder
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "ResourceWithName",
|
||||
in: `{"type":"ref/resource","uri":"my_uri","name":"unexpected_name"}`,
|
||||
want: CompleteReference{}, // placeholder
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "MissingType",
|
||||
in: `{"name":"missing"}`,
|
||||
want: CompleteReference{}, // placeholder
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "InvalidJSON",
|
||||
in: `invalid json`,
|
||||
want: CompleteReference{}, // placeholder
|
||||
wantErr: true, // json.Unmarshal will fail natively
|
||||
},
|
||||
}
|
||||
|
||||
// Run Marshal Tests
|
||||
for _, test := range marshalTests {
|
||||
t.Run("Marshal/"+test.name, func(t *testing.T) {
|
||||
gotBytes, err := json.Marshal(&test.in)
|
||||
if (err != nil) != test.wantErr {
|
||||
t.Errorf("json.Marshal(%v) got error %v (want error %t)", test.in, err, test.wantErr)
|
||||
}
|
||||
if !test.wantErr { // Only check JSON output if marshal was expected to succeed
|
||||
if diff := cmp.Diff(test.want, string(gotBytes)); diff != "" {
|
||||
t.Errorf("json.Marshal(%v) mismatch (-want +got):\n%s", test.in, diff)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// Run Unmarshal Tests
|
||||
for _, test := range unmarshalTests {
|
||||
t.Run("Unmarshal/"+test.name, func(t *testing.T) {
|
||||
var got CompleteReference
|
||||
err := json.Unmarshal([]byte(test.in), &got)
|
||||
|
||||
if (err != nil) != test.wantErr {
|
||||
t.Errorf("json.Unmarshal(%q) got error %v (want error %t)", test.in, err, test.wantErr)
|
||||
}
|
||||
if !test.wantErr { // Only check content if unmarshal was expected to succeed
|
||||
if diff := cmp.Diff(test.want, got); diff != "" {
|
||||
t.Errorf("json.Unmarshal(%q) mismatch (-want +got):\n%s", test.in, diff)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
func TestCompleteParams(t *testing.T) {
|
||||
// Define test cases specifically for Marshalling
|
||||
marshalTests := []struct {
|
||||
name string
|
||||
in CompleteParams
|
||||
want string // Expected JSON output
|
||||
}{
|
||||
{
|
||||
name: "BasicPromptCompletion",
|
||||
in: CompleteParams{
|
||||
Ref: &CompleteReference{
|
||||
Type: "ref/prompt",
|
||||
Name: "my_prompt",
|
||||
},
|
||||
Argument: CompleteParamsArgument{
|
||||
Name: "language",
|
||||
Value: "go",
|
||||
},
|
||||
},
|
||||
want: `{"argument":{"name":"language","value":"go"},"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
},
|
||||
{
|
||||
name: "ResourceCompletionRequest",
|
||||
in: CompleteParams{
|
||||
Ref: &CompleteReference{
|
||||
Type: "ref/resource",
|
||||
URI: "file:///src/main.java",
|
||||
},
|
||||
Argument: CompleteParamsArgument{
|
||||
Name: "class",
|
||||
Value: "MyClas",
|
||||
},
|
||||
},
|
||||
want: `{"argument":{"name":"class","value":"MyClas"},"ref":{"type":"ref/resource","uri":"file:///src/main.java"}}`,
|
||||
},
|
||||
{
|
||||
name: "PromptCompletionEmptyArgumentValue",
|
||||
in: CompleteParams{
|
||||
Ref: &CompleteReference{
|
||||
Type: "ref/prompt",
|
||||
Name: "another_prompt",
|
||||
},
|
||||
Argument: CompleteParamsArgument{
|
||||
Name: "query",
|
||||
Value: "",
|
||||
},
|
||||
},
|
||||
want: `{"argument":{"name":"query","value":""},"ref":{"type":"ref/prompt","name":"another_prompt"}}`,
|
||||
},
|
||||
{
|
||||
name: "PromptCompletionWithContext",
|
||||
in: CompleteParams{
|
||||
Ref: &CompleteReference{
|
||||
Type: "ref/prompt",
|
||||
Name: "my_prompt",
|
||||
},
|
||||
Argument: CompleteParamsArgument{
|
||||
Name: "language",
|
||||
Value: "go",
|
||||
},
|
||||
Context: &CompleteContext{
|
||||
Arguments: map[string]string{
|
||||
"framework": "mcp",
|
||||
"language": "python",
|
||||
},
|
||||
},
|
||||
},
|
||||
want: `{"argument":{"name":"language","value":"go"},"context":{"arguments":{"framework":"mcp","language":"python"}},"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
},
|
||||
{
|
||||
name: "PromptCompletionEmptyContextArguments",
|
||||
in: CompleteParams{
|
||||
Ref: &CompleteReference{
|
||||
Type: "ref/prompt",
|
||||
Name: "my_prompt",
|
||||
},
|
||||
Argument: CompleteParamsArgument{
|
||||
Name: "language",
|
||||
Value: "go",
|
||||
},
|
||||
Context: &CompleteContext{
|
||||
Arguments: map[string]string{},
|
||||
},
|
||||
},
|
||||
want: `{"argument":{"name":"language","value":"go"},"context":{},"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
},
|
||||
}
|
||||
|
||||
// Define test cases specifically for Unmarshalling
|
||||
unmarshalTests := []struct {
|
||||
name string
|
||||
in string // JSON string input
|
||||
want CompleteParams // Expected Go struct output
|
||||
}{
|
||||
{
|
||||
name: "BasicPromptCompletion",
|
||||
in: `{"argument":{"name":"language","value":"go"},"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
want: CompleteParams{
|
||||
Ref: &CompleteReference{Type: "ref/prompt", Name: "my_prompt"},
|
||||
Argument: CompleteParamsArgument{Name: "language", Value: "go"},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "ResourceCompletionRequest",
|
||||
in: `{"argument":{"name":"class","value":"MyClas"},"ref":{"type":"ref/resource","uri":"file:///src/main.java"}}`,
|
||||
want: CompleteParams{
|
||||
Ref: &CompleteReference{Type: "ref/resource", URI: "file:///src/main.java"},
|
||||
Argument: CompleteParamsArgument{Name: "class", Value: "MyClas"},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "PromptCompletionWithContext",
|
||||
in: `{"argument":{"name":"language","value":"go"},"context":{"arguments":{"framework":"mcp","language":"python"}},"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
want: CompleteParams{
|
||||
Ref: &CompleteReference{Type: "ref/prompt", Name: "my_prompt"},
|
||||
Argument: CompleteParamsArgument{Name: "language", Value: "go"},
|
||||
Context: &CompleteContext{Arguments: map[string]string{
|
||||
"framework": "mcp",
|
||||
"language": "python",
|
||||
}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "PromptCompletionEmptyContextArguments",
|
||||
in: `{"argument":{"name":"language","value":"go"},"context":{"arguments":{}},"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
want: CompleteParams{
|
||||
Ref: &CompleteReference{Type: "ref/prompt", Name: "my_prompt"},
|
||||
Argument: CompleteParamsArgument{Name: "language", Value: "go"},
|
||||
Context: &CompleteContext{Arguments: map[string]string{}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "PromptCompletionNilContext", // JSON `null` for context
|
||||
in: `{"argument":{"name":"language","value":"go"},"context":null,"ref":{"type":"ref/prompt","name":"my_prompt"}}`,
|
||||
want: CompleteParams{
|
||||
Ref: &CompleteReference{Type: "ref/prompt", Name: "my_prompt"},
|
||||
Argument: CompleteParamsArgument{Name: "language", Value: "go"},
|
||||
Context: nil, // Should unmarshal to nil pointer
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// Run Marshal Tests
|
||||
for _, test := range marshalTests {
|
||||
t.Run("Marshal/"+test.name, func(t *testing.T) {
|
||||
got, err := json.Marshal(&test.in) // Marshal takes a pointer
|
||||
if err != nil {
|
||||
t.Fatalf("json.Marshal(CompleteParams) failed: %v", err)
|
||||
}
|
||||
if diff := cmp.Diff(test.want, string(got)); diff != "" {
|
||||
t.Errorf("CompleteParams marshal mismatch (-want +got):\n%s", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// Run Unmarshal Tests
|
||||
for _, test := range unmarshalTests {
|
||||
t.Run("Unmarshal/"+test.name, func(t *testing.T) {
|
||||
var got CompleteParams
|
||||
if err := json.Unmarshal([]byte(test.in), &got); err != nil {
|
||||
t.Fatalf("json.Unmarshal(CompleteParams) failed: %v", err)
|
||||
}
|
||||
if diff := cmp.Diff(test.want, got); diff != "" {
|
||||
t.Errorf("CompleteParams unmarshal mismatch (-want +got):\n%s", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCompleteResult(t *testing.T) {
|
||||
// Define test cases specifically for Marshalling
|
||||
marshalTests := []struct {
|
||||
name string
|
||||
in CompleteResult
|
||||
want string // Expected JSON output
|
||||
}{
|
||||
{
|
||||
name: "BasicCompletionResult",
|
||||
in: CompleteResult{
|
||||
Completion: CompletionResultDetails{
|
||||
Values: []string{"golang", "google", "goroutine"},
|
||||
Total: 10,
|
||||
HasMore: true,
|
||||
},
|
||||
},
|
||||
want: `{"completion":{"hasMore":true,"total":10,"values":["golang","google","goroutine"]}}`,
|
||||
},
|
||||
{
|
||||
name: "CompletionResultNoTotalNoHasMore",
|
||||
in: CompleteResult{
|
||||
Completion: CompletionResultDetails{
|
||||
Values: []string{"only"},
|
||||
HasMore: false,
|
||||
Total: 0,
|
||||
},
|
||||
},
|
||||
want: `{"completion":{"values":["only"]}}`,
|
||||
},
|
||||
{
|
||||
name: "CompletionResultEmptyValues",
|
||||
in: CompleteResult{
|
||||
Completion: CompletionResultDetails{
|
||||
Values: []string{},
|
||||
Total: 0,
|
||||
HasMore: false,
|
||||
},
|
||||
},
|
||||
want: `{"completion":{"values":[]}}`,
|
||||
},
|
||||
}
|
||||
|
||||
// Define test cases specifically for Unmarshalling
|
||||
unmarshalTests := []struct {
|
||||
name string
|
||||
in string // JSON string input
|
||||
want CompleteResult // Expected Go struct output
|
||||
}{
|
||||
{
|
||||
name: "BasicCompletionResult",
|
||||
in: `{"completion":{"hasMore":true,"total":10,"values":["golang","google","goroutine"]}}`,
|
||||
want: CompleteResult{
|
||||
Completion: CompletionResultDetails{
|
||||
Values: []string{"golang", "google", "goroutine"},
|
||||
Total: 10,
|
||||
HasMore: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "CompletionResultNoTotalNoHasMore",
|
||||
in: `{"completion":{"values":["only"]}}`,
|
||||
want: CompleteResult{
|
||||
Completion: CompletionResultDetails{
|
||||
Values: []string{"only"},
|
||||
HasMore: false,
|
||||
Total: 0,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "CompletionResultEmptyValues",
|
||||
in: `{"completion":{"hasMore":false,"total":0,"values":[]}}`,
|
||||
want: CompleteResult{
|
||||
Completion: CompletionResultDetails{
|
||||
Values: []string{},
|
||||
Total: 0,
|
||||
HasMore: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// Run Marshal Tests
|
||||
for _, test := range marshalTests {
|
||||
t.Run("Marshal/"+test.name, func(t *testing.T) {
|
||||
got, err := json.Marshal(&test.in) // Marshal takes a pointer
|
||||
if err != nil {
|
||||
t.Fatalf("json.Marshal(CompleteResult) failed: %v", err)
|
||||
}
|
||||
if diff := cmp.Diff(test.want, string(got)); diff != "" {
|
||||
t.Errorf("CompleteResult marshal mismatch (-want +got):\n%s", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// Run Unmarshal Tests
|
||||
for _, test := range unmarshalTests {
|
||||
t.Run("Unmarshal/"+test.name, func(t *testing.T) {
|
||||
var got CompleteResult
|
||||
if err := json.Unmarshal([]byte(test.in), &got); err != nil {
|
||||
t.Fatalf("json.Unmarshal(CompleteResult) failed: %v", err)
|
||||
}
|
||||
if diff := cmp.Diff(test.want, got); diff != "" {
|
||||
t.Errorf("CompleteResult unmarshal mismatch (-want +got):\n%s", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestContentUnmarshal(t *testing.T) {
|
||||
// Verify that types with a Content field round-trip properly.
|
||||
roundtrip := func(in, out any) {
|
||||
|
|
|
|||
Loading…
Reference in a new issue