# Chatlog MCP Server - 快速开始指南
## 🚀 一键安装和使用
### 第 1 步: 安装
选择以下任一方式:
```bash
# 方式 1: 源码安装 (推荐)
git clone <your-repo-url>
cd chatlog-mcp-server
pip install -e .
# 方式 2: 使用安装脚本
chmod +x install.sh
./install.sh
# 方式 3: 如果发布到 PyPI
pip install chatlog-mcp-server
```
### 第 2 步: 配置
创建配置文件:
**Linux/macOS:**
```bash
mkdir -p ~/.config/claude
cat > ~/.config/claude/mcp-servers.json << 'EOF'
{
"mcpServers": {
"chatlog": {
"command": "chatlog-mcp",
"args": [],
"env": {
"PYTHONIOENCODING": "utf-8"
}
}
}
}
EOF
```
**Windows:**
```cmd
mkdir %APPDATA%\Claude
echo { "mcpServers": { "chatlog": { "command": "chatlog-mcp", "args": [], "env": { "PYTHONIOENCODING": "utf-8" } } } } > %APPDATA%\Claude\mcp-servers.json
```
### 第 3 步: 使用
在 Claude Code 中直接说:
```
Use the chatlog tool to list chatrooms
```
## 🎯 常用命令
### 命令行使用
```bash
# 查看帮助
chatlog-mcp --help
# 查看版本
chatlog-mcp --version
# 自定义配置
export CHATLOG_API_URL=http://localhost:5030
export CHATLOG_LOG_LEVEL=debug
chatlog-mcp
```
### 分析聊天数据
```bash
# 获取数据
curl "http://127.0.0.1:5030/api/v1/chatlog?time=2026-01-13&talker=123@chatroom&format=json" > data.json
# 分析数据
python -m chatlog_mcp.examples.analyze data.json --output report.html
```
## 📦 项目文件
```
chatlog-mcp-server/
├── setup.py # 安装配置
├── requirements.txt # 依赖
├── README.md # 详细文档
├── install.sh # Linux/macOS 安装脚本
├── install.bat # Windows 安装脚本
├── chatlog_mcp/ # 主包
│ ├── server.py # MCP 服务器
│ ├── cli.py # 命令行入口
│ ├── examples/ # 示例
│ └── tests/ # 测试
└── docs/ # 文档
```
## 🔧 开发
```bash
# 安装开发环境
pip install -e ".[dev]"
# 运行测试
pytest
# 构建包
python build.py
# 发布
./publish.sh --test # 测试 PyPI
./publish.sh --prod # 生产 PyPI
```
## 📚 文档
- **README.md** - 完整项目说明
- **API.md** - API 文档
- **CONTRIBUTING.md** - 贡献指南
- **PROJECT-STRUCTURE.md** - 项目结构
- **TROUBLESHOOTING.md** - 故障排除
## ❓ 常见问题
### Q: 安装失败?
A: 确保 Python 3.10+ 和 pip 已安装
### Q: 命令不存在?
A: 尝试 `python -m chatlog_mcp.cli`
### Q: MCP 连接失败?
A: 检查 HTTP API 服务器是否运行
### Q: 中文乱码?
A: 确保设置了 `PYTHONIOENCODING=utf-8`
## 🎉 成功!
现在您可以开始使用 Chatlog MCP Server 了!
更多详情请参考 README.md
