Claude MCP 项目使用教程
项目地址: https://gitcode.com/gh_mirrors/co/codemcp 1. 项目目录结构及介绍
Claude MCP 项目旨在将 Claude Desktop 变为一个代码辅助编程工具。以下是项目的目录结构及文件介绍：
- rules/: 存储代码修改规则和模式。
- github/workflows/: 存储项目的 GitHub Actions 工作流文件。
- codemcp/: 存储项目的主要 Python 代码。
- stubs/: 存储外部库的类型存根。
- tests/: 存储单元测试代码。
- .editorconfig: EditorConfig 文件，用于配置代码编辑器设置。
- .gitignore: Git 忽略文件，指定哪些文件和目录应该被 Git 忽略。
- .pre-commit-config.yaml: pre-commit 配置文件，用于配置代码提交前钩子。
- ARCHITECTURE.md: 项目架构介绍。
- CLAUDE.md: Claude 相关的文档。
- CONTRIBUTING.md: 贡献指南。
- LICENSE.txt: 项目许可证文件。
- README.md: 项目自述文件。
- TODO.md: 待办事项列表。
- codemcp.toml: 项目配置文件。
- codemcp.toml.example: 项目配置文件示例。
- prompt.txt: 提示文本文件。
- pyproject.toml: Python 项目配置文件。
- run_format.sh: 格式化代码的脚本。
- run_lint.sh: 代码检查脚本。
- run_test.sh: 运行测试的脚本。
- run_typecheck.sh: 类型检查脚本。
- uv.lock: uv 工具的锁定文件。
2. 项目的启动文件介绍
项目的启动主要是通过配置 Claude Desktop 来加载 MCP（Modify Code Provider）服务。以下是一些基本的步骤：
- 安装 uv 和 git（在 Windows 上，安装 Git 后建议重启电脑）。
- 修改
claude_desktop_config.json文件，添加 MCP 服务的配置。 - 重启 Claude Desktop 应用。如果成功加载，将显示一个锤子图标，点击后可看到 "codemcp"。
在 Windows 上，配置文件的路径可能需要使用双反斜杠。
3. 项目的配置文件介绍
项目的主要配置文件是 codemcp.toml。以下是配置文件的一些基本内容：
- project_prompt: 项目提示，可以在初始化项目时加载。
- commands: 命令配置，用于定义项目中的命令，如格式化、测试等。
例如：
[commands]
format = ["./run_format.sh"]
test = ["./run_test.sh"]
在 codemcp.toml 文件中，还可以为每个命令提供详细的文档说明，以便更好地指导 Claude 如何使用这些工具。
通过上述介绍，您应该对如何使用 Claude MCP 项目有了基本的了解。使用时，请确保遵循项目的配置指南和文档。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
