关键词

代码分析报告生成MCPRustWeb界面性能分析安全扫描

项目简介

Squirrel 代码分析与报告系统是一个使用 Rust 构建的高性能应用后端，它通过 Machine Context Protocol (MCP) 实现客户端-服务器通信，旨在为 LLM 客户端提供代码分析、报告生成和洞察分析服务。该系统支持多种代码分析功能，并可通过 Web 界面进行任务提交、进度跟踪和报告下载。

主要功能点

  • 代码分析: 支持安全扫描、性能分析、代码风格检查和最佳实践验证等多种代码分析功能。
  • 报告生成: 能够生成 Markdown、HTML、PDF 和 JSON 等多种格式的分析报告。
  • MCP 服务器: 基于 Machine Context Protocol 构建，提供标准化的上下文信息和功能接口，支持 LLM 客户端进行交互。
  • Web 界面: 提供友好的 Web 界面，用于提交分析任务、监控任务进度、查看和下载报告。

安装步骤

  1. 安装 Rust 环境: 确保已安装最新稳定版本的 Rust 开发环境。
  2. 安装 PostgreSQL 数据库: 安装并运行 PostgreSQL 数据库 (版本 14.0 或更高)。
  3. 安装 OpenSSL 开发库: 确保安装了 OpenSSL 开发库。
  4. 克隆仓库: 使用 'git clone <仓库URL>' 命令克隆仓库到本地。
  5. 配置数据库: 创建一个新的 PostgreSQL 数据库 'code_analysis'，并根据需要运行数据库迁移（如果已实现）。
  6. 配置环境: 复制 'config.example.toml' 文件为 'config.toml'，并根据您的 PostgreSQL 设置编辑 'config.toml' 文件。
  7. 构建项目: 使用 'cargo build --release' 命令构建项目。

服务器配置

MCP 服务器配置主要通过命令行参数进行，无需复杂的 JSON 配置文件。

MCP 服务器启动命令 (command):

cargo run -p mcp -- server

参数 (args):

无特定启动参数。服务器默认监听配置在 'config.toml' 文件中指定。

配置信息 (JSON):

{
  "server name": "Squirrel MCP Server",
  "command": "cargo run -p mcp -- server",
  "args": [],
  "description": "启动 Squirrel 代码分析 MCP 服务器",
  "notes": "服务器配置主要在 config.toml 文件中，启动命令无需额外参数。"
}

基本使用方法

  1. 启动 Web 服务器: 运行 'cargo run -p web' 命令启动 Web 界面。
  2. 启动 MCP 服务器: 运行 'cargo run -p mcp -- server' 命令启动 MCP 服务器。
  3. 访问 Web 界面: 通过浏览器访问 'http://localhost:3000'，即可使用 Web 界面提交代码分析任务和查看报告。
  4. LLM 客户端集成: LLM 客户端可以通过 JSON-RPC 协议与 MCP 服务器进行通信，利用服务器提供的资源、工具和 Prompt 模板进行更深入的代码分析和交互。具体 API 文档请参考 API.md。

信息

分类

开发者工具

访问项目