File size: 14,169 Bytes
74d8e8f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
"""
MCP工具定义配置模块
MCP Tool Definitions Configuration Module
将工具定义从主程序逻辑中分离,提供标准化的工具定义格式
Separate tool definitions from main program logic, providing standardized tool definition format
支持的工具类型:
- 文件操作工具 (File Operations)
- 代码执行工具 (Code Execution)
- 搜索工具 (Search Tools)
- 项目结构工具 (Project Structure Tools)
"""
from typing import Dict, List, Any
class MCPToolDefinitions:
"""MCP工具定义管理器"""
@staticmethod
def get_code_implementation_tools() -> List[Dict[str, Any]]:
"""
获取代码实现相关的工具定义
Get tool definitions for code implementation
"""
return [
MCPToolDefinitions._get_read_file_tool(),
MCPToolDefinitions._get_read_multiple_files_tool(),
MCPToolDefinitions._get_read_code_mem_tool(),
MCPToolDefinitions._get_write_file_tool(),
MCPToolDefinitions._get_write_multiple_files_tool(),
MCPToolDefinitions._get_execute_python_tool(),
MCPToolDefinitions._get_execute_bash_tool(),
]
@staticmethod
def _get_read_file_tool() -> Dict[str, Any]:
"""读取文件工具定义"""
return {
"name": "read_file",
"description": "Read file content, supports specifying line number range",
"input_schema": {
"type": "object",
"properties": {
"file_path": {
"type": "string",
"description": "File path, relative to workspace",
},
"start_line": {
"type": "integer",
"description": "Start line number (starting from 1, optional)",
},
"end_line": {
"type": "integer",
"description": "End line number (starting from 1, optional)",
},
},
"required": ["file_path"],
},
}
@staticmethod
def _get_read_multiple_files_tool() -> Dict[str, Any]:
"""批量读取多个文件工具定义"""
return {
"name": "read_multiple_files",
"description": "Read multiple files in a single operation (for batch reading)",
"input_schema": {
"type": "object",
"properties": {
"file_requests": {
"type": "string",
"description": 'JSON string with file requests, e.g., \'{"file1.py": {}, "file2.py": {"start_line": 1, "end_line": 10}}\' or simple array \'["file1.py", "file2.py"]\'',
},
"max_files": {
"type": "integer",
"description": "Maximum number of files to read in one operation",
"default": 5,
"minimum": 1,
"maximum": 10,
},
},
"required": ["file_requests"],
},
}
@staticmethod
def _get_read_code_mem_tool() -> Dict[str, Any]:
"""Read code memory tool definition - reads from implement_code_summary.md"""
return {
"name": "read_code_mem",
"description": "Check if file summaries exist in implement_code_summary.md for multiple files in a single call. Returns summaries for all requested files if available.",
"input_schema": {
"type": "object",
"properties": {
"file_paths": {
"type": "array",
"items": {"type": "string"},
"description": "List of file paths to check for summary information in implement_code_summary.md",
}
},
"required": ["file_paths"],
},
}
@staticmethod
def _get_write_file_tool() -> Dict[str, Any]:
"""写入文件工具定义"""
return {
"name": "write_file",
"description": "Write content to file",
"input_schema": {
"type": "object",
"properties": {
"file_path": {
"type": "string",
"description": "File path, relative to workspace",
},
"content": {
"type": "string",
"description": "Content to write to file",
},
"create_dirs": {
"type": "boolean",
"description": "Whether to create directories if they don't exist",
"default": True,
},
"create_backup": {
"type": "boolean",
"description": "Whether to create backup file if file already exists",
"default": False,
},
},
"required": ["file_path", "content"],
},
}
@staticmethod
def _get_write_multiple_files_tool() -> Dict[str, Any]:
"""批量写入多个文件工具定义"""
return {
"name": "write_multiple_files",
"description": "Write multiple files in a single operation (for batch implementation)",
"input_schema": {
"type": "object",
"properties": {
"file_implementations": {
"type": "string",
"description": 'JSON string mapping file paths to content, e.g., \'{"file1.py": "content1", "file2.py": "content2"}\'',
},
"create_dirs": {
"type": "boolean",
"description": "Whether to create directories if they don't exist",
"default": True,
},
"create_backup": {
"type": "boolean",
"description": "Whether to create backup files if they already exist",
"default": False,
},
"max_files": {
"type": "integer",
"description": "Maximum number of files to write in one operation",
"default": 5,
"minimum": 1,
"maximum": 10,
},
},
"required": ["file_implementations"],
},
}
@staticmethod
def _get_execute_python_tool() -> Dict[str, Any]:
"""Python执行工具定义"""
return {
"name": "execute_python",
"description": "Execute Python code and return output",
"input_schema": {
"type": "object",
"properties": {
"code": {"type": "string", "description": "Python code to execute"},
"timeout": {
"type": "integer",
"description": "Timeout in seconds",
"default": 30,
},
},
"required": ["code"],
},
}
@staticmethod
def _get_execute_bash_tool() -> Dict[str, Any]:
"""Bash执行工具定义"""
return {
"name": "execute_bash",
"description": "Execute bash command",
"input_schema": {
"type": "object",
"properties": {
"command": {
"type": "string",
"description": "Bash command to execute",
},
"timeout": {
"type": "integer",
"description": "Timeout in seconds",
"default": 30,
},
},
"required": ["command"],
},
}
@staticmethod
def _get_file_structure_tool() -> Dict[str, Any]:
"""文件结构获取工具定义"""
return {
"name": "get_file_structure",
"description": "Get directory file structure",
"input_schema": {
"type": "object",
"properties": {
"directory": {
"type": "string",
"description": "Directory path, relative to workspace",
"default": ".",
},
"max_depth": {
"type": "integer",
"description": "Maximum traversal depth",
"default": 5,
},
},
},
}
@staticmethod
def _get_search_code_references_tool() -> Dict[str, Any]:
"""统一代码参考搜索工具定义 - 合并了三个步骤为一个工具"""
return {
"name": "search_code_references",
"description": "UNIFIED TOOL: Search relevant reference code from index files. Combines directory setup, index loading, and searching in a single call.",
"input_schema": {
"type": "object",
"properties": {
"indexes_path": {
"type": "string",
"description": "Path to the indexes directory containing JSON index files",
},
"target_file": {
"type": "string",
"description": "Target file path to be implemented",
},
"keywords": {
"type": "string",
"description": "Search keywords, comma-separated",
"default": "",
},
"max_results": {
"type": "integer",
"description": "Maximum number of results to return",
"default": 10,
},
},
"required": ["indexes_path", "target_file"],
},
}
@staticmethod
def _get_get_indexes_overview_tool() -> Dict[str, Any]:
"""获取索引概览工具定义"""
return {
"name": "get_indexes_overview",
"description": "Get overview of all available reference code index information from specified directory",
"input_schema": {
"type": "object",
"properties": {
"indexes_path": {
"type": "string",
"description": "Path to the indexes directory containing JSON index files",
}
},
"required": ["indexes_path"],
},
}
@staticmethod
def _get_set_workspace_tool() -> Dict[str, Any]:
"""Set workspace directory tool definition"""
return {
"name": "set_workspace",
"description": "Set the workspace directory for file operations",
"input_schema": {
"type": "object",
"properties": {
"workspace_path": {
"type": "string",
"description": "Directory path for the workspace",
}
},
"required": ["workspace_path"],
},
}
# @staticmethod
# def _get_set_indexes_directory_tool() -> Dict[str, Any]:
# """Set indexes directory tool definition - DEPRECATED: Use unified search_code_references instead"""
# return {
# "name": "set_indexes_directory",
# "description": "Set the directory path for code reference indexes",
# "input_schema": {
# "type": "object",
# "properties": {
# "indexes_path": {
# "type": "string",
# "description": "Directory path containing index JSON files"
# }
# },
# "required": ["indexes_path"]
# }
# }
@staticmethod
def get_available_tool_sets() -> Dict[str, str]:
"""
获取可用的工具集合
Get available tool sets
"""
return {
"code_implementation": "代码实现相关工具集 / Code implementation tool set",
# 可以在这里添加更多工具集
# "data_analysis": "数据分析工具集 / Data analysis tool set",
# "web_scraping": "网页爬取工具集 / Web scraping tool set",
}
@staticmethod
def get_tool_set(tool_set_name: str) -> List[Dict[str, Any]]:
"""
根据名称获取特定的工具集
Get specific tool set by name
"""
tool_sets = {
"code_implementation": MCPToolDefinitions.get_code_implementation_tools(),
}
return tool_sets.get(tool_set_name, [])
@staticmethod
def get_all_tools() -> List[Dict[str, Any]]:
"""
获取所有可用工具
Get all available tools
"""
all_tools = []
for tool_set_name in MCPToolDefinitions.get_available_tool_sets().keys():
all_tools.extend(MCPToolDefinitions.get_tool_set(tool_set_name))
return all_tools
# 便捷访问函数
def get_mcp_tools(tool_set: str = "code_implementation") -> List[Dict[str, Any]]:
"""
便捷函数:获取MCP工具定义
Convenience function: Get MCP tool definitions
Args:
tool_set: 工具集名称 (默认: "code_implementation")
Returns:
工具定义列表
"""
return MCPToolDefinitions.get_tool_set(tool_set)
|