🚀 使用说明

本项目提供了在 Codemaster 中进行代码操作、运行示例、配置选项、日志记录、调试和类型检查等功能的详细说明。

🚀 快速开始

代码操作界面

在 Codemaster 界面中使用以下命令进行初始化：

mcp init codemaster-config.toml

若要配置 Codemaster，请参考其文档。

运行示例

运行示例项目，可按以下步骤操作：

cd examples
python3 run_example.py

✨ 主要特性

本项目支持多种配置选项，包括全局配置和项目特定配置，同时提供了日志记录、调试和类型检查等功能。

📦 安装指南

文档中未提及安装步骤，暂不提供相关内容。

💻 使用示例

基础用法

代码操作界面初始化

# 在 Codemaster 界面中使用此命令进行初始化
mcp init codemaster-config.toml

运行示例项目

# 进入示例项目目录
cd examples
# 运行示例项目
python3 run_example.py

高级用法

调试服务器

# 运行带调试器的服务器
PYTHONPATH=. mcp dev codemcp/__main__.py

类型检查

# 进行类型检查
./run_typecheck.sh

📚 详细文档

配置选项

全局配置

编辑 ~/.codemcprc 文件以设置全局选项，示例如下：

[global]
# 项目根目录
project_root = "."
# 日志级别
log_level = "INFO"

# 语言模型设置
[model]
# 温度参数
temperature = 0.7
# 最大令牌数
max_tokens = 2048

项目特定配置

在项目根目录中创建 codemcp.toml 文件进行项目特定配置，示例如下：

[commit]
# 提交消息模板
message_template = "feat: implement {feature} ({issue})"
# 分支名称
branch_name = "develop"

# 提交选项
[git]
# 远程仓库
remote = "origin"
# 是否自动推送
push = true

# 日志记录
[logger]
# 是否启用日志记录
enabled = true
# 日志文件
file = "codemcp.log"
# 日志级别
level = "INFO"

日志记录

日志文件位于 ~/.codemcp/codemcp.log。日志级别可以在全局配置文件 ~/.codemcprc 中设置，示例如下：

[logger]
# 日志详细程度，可以是 DEBUG, INFO, WARNING, ERROR, 或者 CRITICAL
verbosity = "INFO"

调试

运行带调试器的服务器，使用以下命令：

PYTHONPATH=. mcp dev codemcp/__main__.py

类型检查

项目使用 pyright 进行类型检查，启用了严格模式。类型检查配置在 pyproject.toml 中。要进行类型检查，请运行：

./run_typecheck.sh

🔧 技术细节

项目使用 pyright 进行类型检查，并启用了严格模式，类型检查配置在 pyproject.toml 中。通过配置全局和项目特定的配置文件，可以灵活设置项目的各种参数，如日志级别、提交消息模板等。同时，项目支持日志记录功能，方便开发者进行调试和问题排查。

📄 许可证

文档中未提及许可证信息，暂不提供相关内容。