clear_buffer
Clear the output buffer of a specified UART terminal session to remove accumulated data and prevent overflow issues during serial communication.
Instructions
清空指定终端会话的输出缓冲区
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| session_id | Yes | 会话ID（即串口路径），如 /dev/ttyUSB0 或 COM1 |
Implementation Reference
- src/uart_mcp/tools/terminal.py:116-127 (handler)The handler function for the clear_buffer MCP tool, which invokes the terminal manager's clear_buffer method.def clear_buffer(session_id: str) -> dict[str, Any]: """清空会话输出缓冲区 Args: session_id: 会话ID（串口路径） Returns: 操作结果 """ manager = get_terminal_manager() return manager.clear_buffer(session_id)
- The schema definition for the clear_buffer tool, including input validation schema.CLEAR_BUFFER_TOOL: dict[str, Any] = { "name": "clear_buffer", "description": "清空指定终端会话的输出缓冲区", "inputSchema": { "type": "object", "properties": { "session_id": { "type": "string", "description": "会话ID（即串口路径），如 /dev/ttyUSB0 或 COM1", }, }, "required": ["session_id"], }, }
- src/uart_mcp/server.py:133-137 (registration)Registration of clear_buffer tool in the server's list_tools() handler.types.Tool( name=CLEAR_BUFFER_TOOL["name"], description=CLEAR_BUFFER_TOOL["description"], inputSchema=CLEAR_BUFFER_TOOL["inputSchema"], ),
- src/uart_mcp/server.py:175-176 (registration)Dispatch logic for clear_buffer in the server's call_tool() handler.elif name == "clear_buffer": result = clear_buffer(**arguments)
- Core helper method in TerminalManager.clear_buffer that performs the actual buffer clearing on the session.def clear_buffer(self, session_id: str) -> dict[str, Any]: """清空终端缓冲区 Args: session_id: 会话ID（串口路径） Returns: 操作结果 Raises: SessionNotFoundError: 会话不存在 """ session = self.get_session(session_id) session.clear_buffer() return {"success": True, "session_id": session_id}