Skip to content

Commit 8f8e20d

Browse files
committed
docs(experimental): add docstrings to default task handler functions
Six public async functions in task_handlers.py lacked docstrings, violating the project's requirement that public APIs have docstrings (AGENTS.md, CONTRIBUTING.md). Each docstring describes the function's purpose and the error code it returns by default.
1 parent e8e6484 commit 8f8e20d

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

src/mcp/client/experimental/task_handlers.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ async def default_get_task_handler(
118118
context: RequestContext[ClientSession],
119119
params: types.GetTaskRequestParams,
120120
) -> types.GetTaskResult | types.ErrorData:
121+
"""Default handler for tasks/get requests; returns METHOD_NOT_FOUND."""
121122
return types.ErrorData(
122123
code=types.METHOD_NOT_FOUND,
123124
message="tasks/get not supported",
@@ -128,6 +129,7 @@ async def default_get_task_result_handler(
128129
context: RequestContext[ClientSession],
129130
params: types.GetTaskPayloadRequestParams,
130131
) -> types.GetTaskPayloadResult | types.ErrorData:
132+
"""Default handler for tasks/result requests; returns METHOD_NOT_FOUND."""
131133
return types.ErrorData(
132134
code=types.METHOD_NOT_FOUND,
133135
message="tasks/result not supported",
@@ -138,6 +140,7 @@ async def default_list_tasks_handler(
138140
context: RequestContext[ClientSession],
139141
params: types.PaginatedRequestParams | None,
140142
) -> types.ListTasksResult | types.ErrorData:
143+
"""Default handler for tasks/list requests; returns METHOD_NOT_FOUND."""
141144
return types.ErrorData(
142145
code=types.METHOD_NOT_FOUND,
143146
message="tasks/list not supported",
@@ -148,6 +151,7 @@ async def default_cancel_task_handler(
148151
context: RequestContext[ClientSession],
149152
params: types.CancelTaskRequestParams,
150153
) -> types.CancelTaskResult | types.ErrorData:
154+
"""Default handler for tasks/cancel requests; returns METHOD_NOT_FOUND."""
151155
return types.ErrorData(
152156
code=types.METHOD_NOT_FOUND,
153157
message="tasks/cancel not supported",
@@ -159,6 +163,7 @@ async def default_task_augmented_sampling(
159163
params: types.CreateMessageRequestParams,
160164
task_metadata: types.TaskMetadata,
161165
) -> types.CreateTaskResult | types.ErrorData:
166+
"""Default handler for task-augmented sampling; returns INVALID_REQUEST."""
162167
return types.ErrorData(
163168
code=types.INVALID_REQUEST,
164169
message="Task-augmented sampling not supported",
@@ -170,6 +175,7 @@ async def default_task_augmented_elicitation(
170175
params: types.ElicitRequestParams,
171176
task_metadata: types.TaskMetadata,
172177
) -> types.CreateTaskResult | types.ErrorData:
178+
"""Default handler for task-augmented elicitation; returns INVALID_REQUEST."""
173179
return types.ErrorData(
174180
code=types.INVALID_REQUEST,
175181
message="Task-augmented elicitation not supported",

0 commit comments

Comments
 (0)