Rename pollFrequency to pollInterval

Author: LucaButBoring

examples/shared/in_memory_task_store.py

@@ -52,7 +52,7 @@ async def create_task(self, task: TaskMetadata, request_id: RequestId, request:
             taskId=task_id,
             status="submitted",
             keepAlive=task.keepAlive,
-            pollFrequency=500,  # Default 500ms poll frequency
+            pollInterval=500,  # Default 500ms poll frequency
         )
 
         self._tasks[task_id] = StoredTask(task=task_obj, request=request, request_id=request_id)

src/mcp/client/session.py

@@ -636,7 +636,7 @@ async def _received_request(self, responder: RequestResponder[types.ServerReques
                                 taskId=task.taskId,
                                 status=task.status,
                                 keepAlive=task.keepAlive,
-                                pollFrequency=task.pollFrequency,
+                                pollInterval=task.pollInterval,
                                 error=task.error,
                                 _meta={types.RELATED_TASK_META_KEY: {"taskId": params.taskId}},
                             )

src/mcp/server/session.py

@@ -209,7 +209,7 @@ async def _received_request(  # noqa: PLR0912
                                 taskId=task.taskId,
                                 status=task.status,
                                 keepAlive=task.keepAlive,
-                                pollFrequency=task.pollFrequency,
+                                pollInterval=task.pollInterval,
                                 error=task.error,
                                 _meta={types.RELATED_TASK_META_KEY: {"taskId": params.taskId}},
                             )

src/mcp/shared/request.py

@@ -179,7 +179,7 @@ async def _task_handler(
                 break
 
             # Wait before polling again
-            poll_frequency = task.pollFrequency if task.pollFrequency is not None else DEFAULT_POLLING_INTERVAL * 1000
+            poll_frequency = task.pollInterval if task.pollInterval is not None else DEFAULT_POLLING_INTERVAL * 1000
             await anyio.sleep(poll_frequency / 1000.0)
 
         # Retrieve and return the result

src/mcp/shared/task.py

@@ -37,7 +37,7 @@ async def get_task(self, task_id: str) -> Task | None:
             task_id: The task identifier
 
         Returns:
-            The task state including status, keepAlive, pollFrequency, and optional error,
+            The task state including status, keepAlive, pollInterval, and optional error,
             or None if task not found
         """
         ...

src/mcp/types.py

@@ -490,7 +490,7 @@ class Task(BaseModel):
     None means the task will not be automatically cleaned up.
     """
 
-    pollFrequency: int | None = None
+    pollInterval: int | None = None
     """Recommended polling frequency in milliseconds for checking task status."""
 
     error: str | None = None
@@ -540,7 +540,7 @@ class GetTaskResult(Result):
     keepAlive: int | None = None
     """Time in milliseconds to keep task results available after completion."""
 
-    pollFrequency: int | None = None
+    pollInterval: int | None = None
     """Recommended polling frequency in milliseconds for checking task status."""
 
     error: str | None = None

tests/shared/test_pending_request.py

@@ -99,9 +99,9 @@ async def never_completes():
 
         # Set up task status progression
         mock_session.get_task.side_effect = [
-            GetTaskResult(taskId="task-1", status="submitted", pollFrequency=100),
-            GetTaskResult(taskId="task-1", status="working", pollFrequency=100),
-            GetTaskResult(taskId="task-1", status="completed", pollFrequency=100),
+            GetTaskResult(taskId="task-1", status="submitted", pollInterval=100),
+            GetTaskResult(taskId="task-1", status="working", pollInterval=100),
+            GetTaskResult(taskId="task-1", status="completed", pollInterval=100),
         ]
         mock_session.get_task_result.return_value = sample_result
 
@@ -142,8 +142,8 @@ async def never_completes():
 
         # Set up task status progression
         task_statuses = [
-            GetTaskResult(taskId="task-2", status="submitted", pollFrequency=50),
-            GetTaskResult(taskId="task-2", status="completed", pollFrequency=50),
+            GetTaskResult(taskId="task-2", status="submitted", pollInterval=50),
+            GetTaskResult(taskId="task-2", status="completed", pollInterval=50),
         ]
         mock_session.get_task.side_effect = task_statuses
         mock_session.get_task_result.return_value = sample_result
@@ -176,7 +176,7 @@ async def notify_created():
     async def test_polling_interval_respects_poll_frequency(
         self, mock_session: MagicMock, sample_result: CallToolResult
     ):
-        """Test that polling interval respects pollFrequency from task."""
+        """Test that polling interval respects pollInterval from task."""
         task_created_event = asyncio.Event()
         task_created_event.set()
 
@@ -193,9 +193,9 @@ async def never_completes():
         async def mock_get_task(task_id: str):
             poll_times.append(asyncio.get_event_loop().time())
             if len(poll_times) == 1:
-                return GetTaskResult(taskId=task_id, status="submitted", pollFrequency=100)  # 100ms
+                return GetTaskResult(taskId=task_id, status="submitted", pollInterval=100)  # 100ms
             else:
-                return GetTaskResult(taskId=task_id, status="completed", pollFrequency=100)
+                return GetTaskResult(taskId=task_id, status="completed", pollInterval=100)
 
         mock_session.get_task.side_effect = mock_get_task
         mock_session.get_task_result.return_value = sample_result
@@ -220,7 +220,7 @@ async def mock_get_task(task_id: str):
     async def test_polling_uses_default_interval_when_not_specified(
         self, mock_session: MagicMock, sample_result: CallToolResult
     ):
-        """Test that default polling interval is used when pollFrequency is None."""
+        """Test that default polling interval is used when pollInterval is None."""
         task_created_event = asyncio.Event()
         task_created_event.set()
 
@@ -236,9 +236,9 @@ async def never_completes():
         async def mock_get_task(task_id: str):
             poll_times.append(asyncio.get_event_loop().time())
             if len(poll_times) == 1:
-                return GetTaskResult(taskId=task_id, status="submitted", pollFrequency=None)
+                return GetTaskResult(taskId=task_id, status="submitted", pollInterval=None)
             else:
-                return GetTaskResult(taskId=task_id, status="completed", pollFrequency=None)
+                return GetTaskResult(taskId=task_id, status="completed", pollInterval=None)
 
         mock_session.get_task.side_effect = mock_get_task
         mock_session.get_task_result.return_value = sample_result
@@ -279,7 +279,7 @@ async def get_result():
         # Set up task polling to be slow
         async def slow_get_task(task_id: str):
             await asyncio.sleep(0.2)
-            return GetTaskResult(taskId=task_id, status="submitted", pollFrequency=100)
+            return GetTaskResult(taskId=task_id, status="submitted", pollInterval=100)
 
         mock_session.get_task.side_effect = slow_get_task
 
@@ -319,7 +319,7 @@ async def never_completes():
             return sample_result
 
         # Set up task polling to complete quickly
-        mock_session.get_task.return_value = GetTaskResult(taskId="task-6", status="completed", pollFrequency=100)
+        mock_session.get_task.return_value = GetTaskResult(taskId="task-6", status="completed", pollInterval=100)
         mock_session.get_task_result.return_value = sample_result
 
         pending = PendingRequest(
@@ -420,7 +420,7 @@ async def slow_result_with_error():
             raise RuntimeError("Direct result also failed")
 
         # Task polling succeeds but result retrieval fails
-        mock_session.get_task.return_value = GetTaskResult(taskId="task-9", status="completed", pollFrequency=100)
+        mock_session.get_task.return_value = GetTaskResult(taskId="task-9", status="completed", pollInterval=100)
         mock_session.get_task_result.side_effect = RuntimeError("Failed to retrieve result")
 
         pending = PendingRequest(
@@ -454,7 +454,7 @@ async def never_completes():
         # Set up task polling to never complete
         async def never_complete_get_task(task_id: str):
             await asyncio.sleep(10)
-            return GetTaskResult(taskId=task_id, status="submitted", pollFrequency=100)
+            return GetTaskResult(taskId=task_id, status="submitted", pollInterval=100)
 
         mock_session.get_task.side_effect = never_complete_get_task
 
@@ -494,7 +494,7 @@ async def cancellable_get_task(task_id: str):
             nonlocal get_task_cancelled
             try:
                 await asyncio.sleep(10)  # Will be cancelled
-                return GetTaskResult(taskId=task_id, status="submitted", pollFrequency=100)
+                return GetTaskResult(taskId=task_id, status="submitted", pollInterval=100)
             except asyncio.CancelledError:
                 get_task_cancelled = True
                 raise
@@ -542,7 +542,7 @@ async def never_completes():
             await asyncio.Future()  # Never completes
             return sample_result
 
-        mock_session.get_task.return_value = GetTaskResult(taskId="task-12", status="completed", pollFrequency=100)
+        mock_session.get_task.return_value = GetTaskResult(taskId="task-12", status="completed", pollInterval=100)
         mock_session.get_task_result.return_value = sample_result
 
         pending = PendingRequest(
@@ -572,8 +572,8 @@ async def never_completes():
             return sample_result
 
         mock_session.get_task.side_effect = [
-            GetTaskResult(taskId="task-13", status="submitted", pollFrequency=50),
-            GetTaskResult(taskId="task-13", status="failed", pollFrequency=50, error="Something went wrong"),
+            GetTaskResult(taskId="task-13", status="submitted", pollInterval=50),
+            GetTaskResult(taskId="task-13", status="failed", pollInterval=50, error="Something went wrong"),
         ]
         mock_session.get_task_result.return_value = sample_result
 
@@ -604,8 +604,8 @@ async def never_completes():
             return sample_result
 
         mock_session.get_task.side_effect = [
-            GetTaskResult(taskId="task-14", status="working", pollFrequency=50),
-            GetTaskResult(taskId="task-14", status="cancelled", pollFrequency=50, error="User cancelled"),
+            GetTaskResult(taskId="task-14", status="working", pollInterval=50),
+            GetTaskResult(taskId="task-14", status="cancelled", pollInterval=50, error="User cancelled"),
         ]
         mock_session.get_task_result.return_value = sample_result
 

tests/shared/test_task_store.py

@@ -43,7 +43,7 @@ async def test_create_task_basic(
         assert task.taskId == "test-task-123"
         assert task.status == "submitted"
         assert task.keepAlive == 5000
-        assert task.pollFrequency == 500  # Default value
+        assert task.pollInterval == 500  # Default value
 
     @pytest.mark.anyio
     async def test_create_task_without_keep_alive(self, task_store: InMemoryTaskStore, sample_request: CallToolRequest):