使用说明

用于代码图提取的Python MCP服务器

此MCP（模型上下文协议）服务器提供用于提取和分析Python代码结构的工具，重点关注文件之间的导入/导出关系。这是一个轻量级的实现，不需要代理系统，可以轻松集成到任何Python应用程序中。

特性

代码关系发现：分析Python文件之间的导入关系
智能代码提取：仅提取最相关的代码段，以保持在令牌限制范围内
目录上下文：包含来自同一目录的文件以提供更好的上下文
文档包含：始终包含README.md文件（或变体）以提供项目文档
LLM友好格式：为语言模型设置具有适当元数据的格式代码
MCP协议支持：与模型上下文协议JSON-RPC标准完全兼容

这 `get_python_code` 工具

服务器提供了一个强大的代码提取工具，该工具：

分析目标Python文件并发现所有导入的模块、类和函数
返回目标文件的完整代码
包括其他文件中所有引用对象的代码
从同一目录添加其他上下文文件
尊重令牌限制，避免压倒性的语言模型

安装

# Clone the repository
git clone https://github.com/yourusername/python-mcp-new.git
cd python-mcp-new

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

环境变量

创建一个 .env 基于提供的文件 .env.example:

# Token limit for extraction
TOKEN_LIMIT=8000

用法

配置MCP客户端

要配置此MCP服务器以在MCP兼容客户端（如Codeium Windsurf）中使用，请将以下配置添加到客户端的MCP配置文件中：

{
  "mcpServers": {
    "python-code-explorer": {
      "command": "python",
      "args": [
        "/path/to/python-mcp-new/server.py"
      ],
      "env": {
        "TOKEN_LIMIT": "8000"
      }
    }
  }
}

替换 /path/to/python-mcp-new/server.py 带有系统上server.py文件的绝对路径。

您还可以自定义环境变量：

TOKEN_LIMIT：代码提取的最大令牌限制（默认值：8000）

使用示例

直接函数调用

from agent import get_python_code

# Get Python code structure for a specific file
result = get_python_code(
    target_file="/home/user/project/main.py",
    root_repo_path="/home/user/project"  # Optional, defaults to target file directory
)

# Process the result
target_file = result["target_file"]
print(f"Main file: {target_file['file_path']}")
print(f"Docstring: {target_file['docstring']}")

# Display related files
for ref_file in result["referenced_files"]:
    print(f"Related file: {ref_file['file_path']}")
    print(f"Object: {ref_file['object_name']}")
    print(f"Type: {ref_file['object_type']}")

# See if we're close to the token limit
print(f"Token usage: {result['token_count']}/{result['token_limit']}")

示例响应（直接函数调用）

{
    "target_file": {
        "file_path": "main.py",
        "code": "import os\nimport sys\nfrom utils.helpers import format_output\n\ndef main():\n    args = sys.argv[1:]\n    if not args:\n        print('No arguments provided')\n        return\n    \n    result = format_output(args[0])\n    print(result)\n\nif __name__ == '__main__':\n    main()",
        "type": "target",
        "docstring": ""
    },
    "referenced_files": [
        {
            "file_path": "utils/helpers.py",
            "object_name": "format_output",
            "object_type": "function",
            "code": "def format_output(text):\n    \"\"\"Format the input text for display.\"\"\"\n    if not text:\n        return ''\n    return f'Output: {text.upper()}'\n",
            "docstring": "Format the input text for display.",
            "truncated": false
        }
    ],
    "additional_files": [
        {
            "file_path": "config.py",
            "code": "# Configuration settings\n\nDEBUG = True\nVERSION = '1.0.0'\nMAX_RETRIES = 3\n",
            "type": "related_by_directory",
            "docstring": "Configuration settings for the application."
        }
    ],
    "total_files": 3,
    "token_count": 450,
    "token_limit": 8000
}

使用MCP协议

列出可用工具

from agent import handle_mcp_request
import json

# List available tools
list_request = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/list"
}

response = handle_mcp_request(list_request)
print(json.dumps(response, indent=2))

示例响应（工具/列表）

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "tools": [
      {
        "name": "get_python_code",
        "description": "Return the code of a target Python file and related files based on import/export proximity.",
        "inputSchema": {
          "type": "object",
          "properties": {
            "target_file": {
              "type": "string",
              "description": "Path to the Python file to analyze."
            },
            "root_repo_path": {
              "type": "string",
              "description": "Root directory of the repository. If not provided, the directory of the target file will be used."
            }
          },
          "required": ["target_file"]
        }
      }
    ]
  }
}

调用get_python代码工具

from agent import handle_mcp_request
import json

# Call the get_python_code tool
tool_request = {
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/call",
    "params": {
        "name": "get_python_code",
        "arguments": {
            "target_file": "/home/user/project/main.py",
            "root_repo_path": "/home/user/project"  # Optional
        }
    }
}

response = handle_mcp_request(tool_request)
print(json.dumps(response, indent=2))

示例响应（工具/调用）

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "Python code analysis for /home/user/project/main.py"
      },
      {
        "type": "resource",
        "resource": {
          "uri": "resource://python-code/main.py",
          "mimeType": "application/json",
          "data": {
            "target_file": {
              "file_path": "main.py",
              "code": "import os\nimport sys\nfrom utils.helpers import format_output\n\ndef main():\n    args = sys.argv[1:]\n    if not args:\n        print('No arguments provided')\n        return\n    \n    result = format_output(args[0])\n    print(result)\n\nif __name__ == '__main__':\n    main()",
              "type": "target",
              "docstring": ""
            },
            "referenced_files": [
              {
                "file_path": "utils/helpers.py",
                "object_name": "format_output",
                "object_type": "function",
                "code": "def format_output(text):\n    \"\"\"Format the input text for display.\"\"\"\n    if not text:\n        return ''\n    return f'Output: {text.upper()}'\n",
                "docstring": "Format the input text for display.",
                "truncated": false
              }
            ],
            "additional_files": [
              {
                "file_path": "config.py",
                "code": "# Configuration settings\n\nDEBUG = True\nVERSION = '1.0.0'\nMAX_RETRIES = 3\n",
                "type": "related_by_directory",
                "docstring": "Configuration settings for the application."
              }
            ],
            "total_files": 3,
            "token_count": 450,
            "token_limit": 8000
          }
        }
      }
    ],
    "isError": false
  }
}

处理错误

from agent import handle_mcp_request

# Call with invalid file path
faulty_request = {
    "jsonrpc": "2.0",
    "id": 3,
    "method": "tools/call",
    "params": {
        "name": "get_python_code",
        "arguments": {
            "target_file": "/path/to/nonexistent.py"
        }
    }
}

response = handle_mcp_request(faulty_request)
print(json.dumps(response, indent=2))

错误响应示例

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "Error processing Python code: No such file or directory: '/path/to/nonexistent.py'"
      }
    ],
    "isError": true
  }
}

测试

运行测试以验证功能：

python -m unittest discover tests

关键组件

agent.py：包含 get_python_code 功能和自定义MCP协议处理程序
code_grapher.py：实现 CodeGrapher Python代码分析类
服务器.py：使用MCP Python SDK实现完整的MCP服务器
run_server.py：用于运行MCP服务器的CLI工具
示例/：显示如何使用MCP服务器和客户端的示例脚本
测试/：所有功能的全面测试用例

响应格式详细信息

这 get_python_code 该工具返回一个包含以下字段的结构化JSON对象：

字段	类型	描述
`target_file`	对象	关于目标Python文件的信息
`referenced_files`	Array	目标文件导入的对象列表
`additional_files`	数组	来自同一目录的其他上下文文件
`total_files`	Number	响应中包含的文件总数
`token_count`	数量	所有包含代码中令牌的近似计数
`token_limit`	数量	为提取配置的最大令牌限制

目标文件对象

字段	类型	描述
`file_path`	String	从存储库根目录到文件的相对路径
`code`	String	文件的完整源代码
`type`	字符串	始终为“目标”
`docstring`	String	模块级docstring（如果可用）

引用的文件对象

字段	类型	描述
`file_path`	String	文件的相对路径
`object_name`	String	导入对象的名称（类、函数等）
`object_type`	String	对象的类型（“类”、“函数”等）
`code`	String	特定对象的源代码
`docstring`	String	对象的Docstring（如果可用）
`truncated`	Boolean	代码是否因令牌限制而被截断

附加文件对象

字段	类型	描述
`file_path`	String	文件的相对路径
`code`	String	文件的完整源代码
`type`	String	关系类型（例如，“related_by_directory”）
`docstring`	String	模块级docstring（如果可用）

使用MCP SDK服务器

该项目现在包括一个功能齐全的模型上下文协议（MCP）服务器，该服务器由官方 Python MCP SDK服务器以标准化的方式公开我们的代码提取功能，该功能可用于任何MCP客户端，包括Claude Desktop。

启动服务器

# Start the server with default settings
python run_server.py

# Specify a custom name
python run_server.py --name "My Code Explorer"

# Use a specific .env file
python run_server.py --env-file .env.production

使用MCP开发模式

安装了MCP SDK后，您可以使用MCP CLI在开发模式下运行服务器：

# Install the MCP CLI
pip install "mcp[cli]"

# Start the server in development mode with the Inspector UI
mcp dev server.py

这将启动MCP检查器，这是一个用于测试和调试服务器的web界面。

Claude桌面集成

您可以将服务器安装到Claude Desktop中，直接从Claude访问您的代码探索工具：

# Install the server in Claude Desktop
mcp install server.py

# With custom configuration
mcp install server.py --name "Python Code Explorer" -f .env

自定义服务器部署

对于自定义部署，您可以直接使用MCP服务器：

from server import mcp

# Configure the server
mcp.name = "Custom Code Explorer"

# Run the server
mcp.run()

使用MCP客户端

您可以使用MCP Python SDK以编程方式连接到服务器。请参阅中提供的示例 examples/mcp_client_example.py:

from mcp.client import Client, Transport

# Connect to the server
client = Client(Transport.subprocess(["python", "server.py"]))
client.initialize()

# List available tools
for tool in client.tools:
    print(f"Tool: {tool.name}")

# Use the get_code tool
result = client.tools.get_code(target_file="path/to/your/file.py")
print(f"Found {len(result['referenced_files'])} referenced files")

# Clean up
client.shutdown()

运行示例：

python examples/mcp_client_example.py [optional_target_file.py]

添加其他工具

您可以通过以下方式装饰功能，向MCP服务器添加其他工具 @mcp.tool() 室内装饰师 server.py:

@mcp.tool()
def analyze_imports(target_file: str) -> Dict[str, Any]:
    """Analyze all imports in a Python file."""
    # Implementation code here
    return {
        "file": target_file,
        "imports": [],  # List of imports found
        "analysis": ""  # Analysis of the imports
    }
    
@mcp.tool()
def find_python_files(directory: str, pattern: str = "*.py") -> list[str]:
    """Find Python files matching a pattern in a directory."""
    from pathlib import Path
    return [str(p) for p in Path(directory).glob(pattern) if p.is_file()]

您还可以添加资源端点以直接提供数据：

@mcp.resource("python_stats://{directory}")
def get_stats(directory: str) -> Dict[str, Any]:
    """Get statistics about Python files in a directory."""
    from pathlib import Path
    stats = {
        "directory": directory,
        "file_count": 0,
        "total_lines": 0,
        "average_lines": 0
    }
    
    files = list(Path(directory).glob("**/*.py"))
    stats["file_count"] = len(files)
    
    if files:
        total_lines = 0
        for file in files:
            with open(file, "r") as f:
                total_lines += len(f.readlines())
        stats["total_lines"] = total_lines
        stats["average_lines"] = total_lines / len(files)
    
    return stats

模型上下文协议集成

该项目完全采用模型上下文协议（MCP）标准，提供了两种实现选项：

本地MCP集成：最初实施于 agent.py 提供与MCP兼容的直接JSON-RPC接口。
MCP SDK集成：新的实施 server.py 利用官方的MCP Python SDK，获得更强大、功能更丰富的体验。

MCP集成的好处

标准化接口：使您的工具可用于任何兼容MCP的客户端
增强的安全性：内置权限模型和资源控制
更好的LLM集成：与Claude Desktop和其他LLM平台无缝集成
改善开发人员体验：MCP检查器等综合工具

MCP协议版本

此实现支持MCP协议版本0.7.0。

有关MCP的更多信息，请参阅官方文件.