Skip to content
Merged
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
40 changes: 38 additions & 2 deletions client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package client
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"sync"
Expand Down Expand Up @@ -925,8 +926,12 @@ func (c *Client) CancelTask(
return mcp.ParseCancelTaskResult(response)
}

// ListTasks returns the list of tasks
func (c *Client) ListTasks(
// ErrRepeatedTaskListCursor is returned when tasks/list repeats a cursor that
// was already requested. Following it would request the same page again.
var ErrRepeatedTaskListCursor = errors.New("tasks/list cursor did not advance")

// ListTasksByPage lists one page of tasks.
func (c *Client) ListTasksByPage(
ctx context.Context,
request mcp.ListTasksRequest,
) (*mcp.ListTasksResult, error) {
Expand All @@ -938,6 +943,37 @@ func (c *Client) ListTasks(
return mcp.ParseListTasksResult(response)
}

// ListTasks lists all tasks by following paginated responses.
func (c *Client) ListTasks(
ctx context.Context,
request mcp.ListTasksRequest,
) (*mcp.ListTasksResult, error) {
seen := map[mcp.Cursor]struct{}{request.Params.Cursor: {}}
result, err := c.ListTasksByPage(ctx, request)
if err != nil {
return nil, err
}
for result.NextCursor != "" {
if _, dup := seen[result.NextCursor]; dup {
return nil, fmt.Errorf("%w: %q", ErrRepeatedTaskListCursor, result.NextCursor)
}
select {
case <-ctx.Done():
return nil, ctx.Err()
default:
seen[result.NextCursor] = struct{}{}
request.Params.Cursor = result.NextCursor
page, err := c.ListTasksByPage(ctx, request)
if err != nil {
return nil, err
}
result.Tasks = append(result.Tasks, page.Tasks...)
result.NextCursor = page.NextCursor
Comment thread
o-mid marked this conversation as resolved.
}
}
return result, nil
}

// TaskResult returns finished task result
func (c *Client) TaskResult(
ctx context.Context,
Expand Down
165 changes: 165 additions & 0 deletions client/task_list_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
package client

import (
"context"
"encoding/json"
"errors"
"sync"
"testing"

"github.com/mark3labs/mcp-go/client/transport"
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestClient_ListTasksFollowsPagination(t *testing.T) {
mcpServer := server.NewMCPServer(
"test-server",
"1.0.0",
server.WithTaskCapabilities(true, true, true),
server.WithPaginationLimit(2),
)
mcpServer.AddTool(
mcp.NewTool("noop", mcp.WithTaskSupport(mcp.TaskSupportRequired)),
func(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
return mcp.NewToolResultText("ok"), nil
},
)

var wantIDs []string
for i := range 4 {
response := mcpServer.HandleMessage(t.Context(), []byte(`{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "noop",
"task": {"ttl": 60000}
}
}`))
success, ok := response.(mcp.JSONRPCResponse)
require.Truef(t, ok, "task %d: expected JSONRPCResponse, got %T", i, response)
created, ok := success.Result.(*mcp.CreateTaskResult)
require.Truef(t, ok, "task %d: expected *CreateTaskResult, got %T", i, success.Result)
wantIDs = append(wantIDs, created.Task.TaskId)
}

c, err := NewInProcessClient(mcpServer)
require.NoError(t, err)
t.Cleanup(func() { _ = c.Close() })
require.NoError(t, c.Start(t.Context()))

initReq := mcp.InitializeRequest{}
initReq.Params.ProtocolVersion = mcp.ProtocolVersion20251125
initReq.Params.ClientInfo = mcp.Implementation{Name: "test-client", Version: "1.0.0"}
_, err = c.Initialize(t.Context(), initReq)
require.NoError(t, err)

page, err := c.ListTasksByPage(t.Context(), mcp.ListTasksRequest{})
require.NoError(t, err)
assert.Len(t, page.Tasks, 2)
assert.NotEmpty(t, page.NextCursor)

listed, err := c.ListTasks(t.Context(), mcp.ListTasksRequest{})
require.NoError(t, err)
assert.Empty(t, listed.NextCursor)

var gotIDs []string
for _, task := range listed.Tasks {
gotIDs = append(gotIDs, task.TaskId)
}
assert.ElementsMatch(t, wantIDs, gotIDs)

// A second call starts from the caller's cursor, which is still empty.
again, err := c.ListTasks(t.Context(), mcp.ListTasksRequest{})
require.NoError(t, err)
assert.Len(t, again.Tasks, len(wantIDs))
}

func TestClient_ListTasksRejectsRepeatedCursor(t *testing.T) {
tests := []struct {
name string
pages []mcp.ListTasksResult
wantCalls int
}{
{
name: "same cursor returned again",
pages: []mcp.ListTasksResult{
{Tasks: []mcp.Task{{TaskId: "t1"}}, PaginatedResult: mcp.PaginatedResult{NextCursor: "page-2"}},
{Tasks: []mcp.Task{{TaskId: "t2"}}, PaginatedResult: mcp.PaginatedResult{NextCursor: "page-2"}},
},
wantCalls: 2,
},
{
name: "cursor cycles back to an earlier page",
pages: []mcp.ListTasksResult{
{Tasks: []mcp.Task{{TaskId: "t1"}}, PaginatedResult: mcp.PaginatedResult{NextCursor: "page-2"}},
{Tasks: []mcp.Task{{TaskId: "t2"}}, PaginatedResult: mcp.PaginatedResult{NextCursor: "page-3"}},
{Tasks: []mcp.Task{{TaskId: "t3"}}, PaginatedResult: mcp.PaginatedResult{NextCursor: "page-2"}},
},
wantCalls: 3,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tr := newListTasksPageTransport(tt.pages)
c := NewClient(tr, WithSession())

_, err := c.ListTasks(t.Context(), mcp.ListTasksRequest{})
require.Error(t, err)
assert.ErrorIs(t, err, ErrRepeatedTaskListCursor)
assert.Equal(t, tt.wantCalls, tr.callCount())
})
}
}

type listTasksPageTransport struct {
mu sync.Mutex
pages []mcp.ListTasksResult
calls int
}

func newListTasksPageTransport(pages []mcp.ListTasksResult) *listTasksPageTransport {
return &listTasksPageTransport{pages: pages}
}

func (t *listTasksPageTransport) Start(context.Context) error { return nil }

func (t *listTasksPageTransport) SendRequest(
_ context.Context,
request transport.JSONRPCRequest,
) (*transport.JSONRPCResponse, error) {
t.mu.Lock()
defer t.mu.Unlock()

if request.Method != string(mcp.MethodTasksList) {
return nil, errors.New("unexpected request method")
}
if t.calls >= len(t.pages) {
return nil, errors.New("no scripted tasks/list page")
}
page := t.pages[t.calls]
t.calls++
raw, err := json.Marshal(page)
if err != nil {
return nil, err
}
return &transport.JSONRPCResponse{Result: raw}, nil
}

func (t *listTasksPageTransport) SendNotification(context.Context, mcp.JSONRPCNotification) error {
return nil
}

func (t *listTasksPageTransport) SetNotificationHandler(func(mcp.JSONRPCNotification)) {}
func (t *listTasksPageTransport) Close() error { return nil }
func (t *listTasksPageTransport) GetSessionId() string { return "" }

func (t *listTasksPageTransport) callCount() int {
t.mu.Lock()
defer t.mu.Unlock()
return t.calls
}
Loading