API代码一致性检查工具

DocCodeCheckerMCP是一个用于检查API文档与实现代码一致性的工具,通过比较Swagger文档和Python代码中的关键词,快速识别差异。

  • by yhj25cs-arch
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 yhj25cs-arch/DocCodeCheckerMCP

使用说明

Doccodecheckermcp

MCP是本地环境中的API描述文件

(swagger.json)读取并提取文档中定义的API元素。读取创建服务器的python代码文件,并分别提取代码内部实际使用的单词(函数名、变量名等)。比较两个结果,只输出不一致的项目。帮助您快速确认详细内容和实现代码之间的不一致。

Tool 1.read_swagger_spec:读取swagger.json文件并提取API相关关键字列表

Tool 2.extract_code_tokens:读取python代码文件并提取内部单词(令牌)列表

Tool 3.compare_spec_and_code:比较swagger关键字和代码标记,仅返回差异

结构

Doccodecheckermcp/ ├─ 服务器/ │├&main.py#MCP条目(stdio) │ └─ handlers.py#MCP工具处理程序(字典반환) │ ├─ core/ │ ├─ swagger_parser.py │ ├─ code_tokenizer.py │ └─ 比较器.py │ ├─ 适配器/ │└&file_loader.py#文件I/O(mock目标) │ ├─ 测试/ │ └─ test_swagler_parser.py │ └─ 模式/ ├─ read_swagger_spec.json ├─ extract_code_tokens.json └─ compare_spec_and_code.json