code-scanner-server

code-scanner-server

site icon
2025.04.06 2
JavaScript代码扫描代码分析开发工具开发效率
`code-scanner-server` 是一个多功能代码扫描工具,可作为命令行界面(CLI)工具或 MCP(Model Context Protocol)服务器运行。它使用 Tree-sitter 解析库来分析源代码并提取结构信息,支持多种编程语言,并能根据 `.gitignore` 文件规则进行过滤。该工具可以提取代码中的定义(如函数、类、变量等),并提供多种输出格式(XML、Markdown、JSON)和详细级别(minimal、standard、detailed)。
View on GitHub

Overview

基本能力

产品定位

code-scanner-server 是一个代码扫描工具,旨在帮助开发者快速分析和提取代码库中的结构信息,适用于代码审查、文档生成和 AI 辅助开发等场景。

核心功能

  • 代码定义提取:识别函数、类、变量、接口、方法等。
  • 多语言支持:解析 JavaScript、TypeScript、C#、PHP、CSS 和 Python。
  • .gitignore 感知:自动忽略 .gitignore 中定义的规则。
  • 灵活过滤:支持按定义类型、修饰符、名称模式和文件路径模式过滤结果。
  • 多种输出格式:生成 Markdown(默认)、XML 或 JSON 格式的结果。
  • 可配置的详细级别:输出详细程度分为 minimalstandard(默认)和 detailed
  • 双模式操作:可作为独立 CLI 工具或集成 MCP 服务器运行。

适用场景

  • 代码审查:快速查看代码库中的关键定义。
  • 文档生成:自动生成代码结构文档。
  • AI 辅助开发:为 AI 助手提供代码结构信息,辅助代码生成和理解。

工具列表

  • scan_code:扫描指定目录中的代码文件并返回定义列表,支持多种过滤选项和输出格式。

常见问题解答

  • Q: 如何调试 MCP 服务器模式? A: 使用 npm run inspector 启动服务器,并通过 Chrome DevTools 等工具连接调试。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。

安装教程

  1. 克隆仓库(可选): bash git clone <repository_url> cd code-scanner-server
  2. 安装依赖: bash npm install
  3. 构建项目: bash npm run build

调试方式

  1. 使用监视模式自动重建项目: bash npm run watch
  2. 调试 MCP 服务器: bash npm run inspector 通过提供的 URL 连接调试工具(如 Chrome DevTools)。

许可证

该项目遵循 GPL-3.0 开源许可条款,请参阅 GPL-3.0 了解完整条款。