MCPunk 项目指南

简介

MCPunk 是一个用于与大语言模型（LLM）交互的工具，专为代码分析设计。它将项目中的文件分块处理，并通过工具链进行解析和执行。

核心功能

• 代码感知: 支持 Python 和其他语言的语法高亮、自动完成和错误检测。
• 可执行上下文: 允许在交互式环境中直接运行代码片段。
• 结果呈现: 支持以文本、图表或 HTML 格式展示分析结果。

工作流程

1. 项目配置: 创建并编辑 mcp.json 文件，指定项目结构和工具链。
2. 启动服务: 使用命令行或桌面应用启动 MCPunk 服务。
3. 代码交互: 在集成的开发环境中进行编码、调试和分析。

工具链

MCPunk 提供以下核心工具：

mcp

• 文件管理: 加载和管理项目中的源文件。
• 代码解析: 使用词法分析器和语法树生成代码结构信息。
• 结果缓存: 优化重复计算，提升性能。

mcpy

• 代码执行: 在沙盒环境中安全运行代码片段。
• 调试支持: 提供断点、变量监视和调用堆栈功能。
• 结果处理: 处理并展示执行结果，支持多种格式输出。

示例

# mcp.json 配置示例
{
  "include": ["src/**/*"],
  "exclude": ["tests", "venv"],
  "parsers": {
    "python": {
      "syntax": true,
      "autoComplete": true,
      "diagnostics": true
    }
  },
  "analyzers": {
    "complexity": {
      "threshold": 20
    },
    "dependency": {
      "track": true
    }
  }
}

使用指南

命令行操作

# 初始化项目
mcp init

# 启动服务
mcp start --port 8000

# 执行代码
mcpy examples/hello.py

桌面应用

通过桌面应用，用户可以直观地查看和管理项目文件，进行交互式分析。

系统要求

• 操作系统: 支持 Linux、macOS 和 Windows。
• Python 版本: 3.8 及以上版本。
• 内存要求: 至少 4GB RAM，推荐 8GB 及以上。

常见问题

安装问题

• 确保已正确安装 Python 和依赖项。
• 检查环境变量配置，确保命令可执行。

性能问题

• 使用 --no-cache 选项禁用缓存以排查性能问题。
• 优化项目配置，排除不必要的文件和分析器。

配置选项

MCPunk 支持通过以下方式配置：

• 环境变量: 设置如 MCPUNK_CACHE_SIZE 等变量。
• 命令行参数: 在运行时指定配置参数。
• 配置文件: 使用 mcp.json 定义项目特定设置。

开发指南

代码结构

mcpunk/
├── core/          # 核心算法和工具链实现
│   ├── parser.py      # 文件解析器
│   └── analyzer.py    # 代码分析器
├── interface/     # 用户界面组件
│   ├── cli.py        # 命令行接口
│   └── desktop.py    # 桌面应用框架
└── config/        # 配置管理模块
    └── mcp.json.example  # 示例配置文件

贡献指南

• 提交 issue 报告问题。
• 提交 PR 修复 bug 或添加功能。
• 参与社区讨论，提出改进建议。

未来发展

MCPunk 计划在后续版本中加入以下功能：

• AI 驱动开发: 利用 LLM 进行代码生成和优化。
• 实时协作: 支持多人在线协作开发。
• 跨平台支持: 优化对不同操作系统的兼容性。

参考文档

• 官方文档
• API 文档
• 社区论坛

通过以上指南，用户可以全面了解 MCPunk 的功能和使用方法，充分发挥其在代码分析和交互式开发中的潜力。