init

docs/kimi-cli-setup.md

@@ -0,0 +1,124 @@
+# Kimi Code CLI 配置指南
+
+本文档介绍如何在 Kimi Code CLI 中配置和使用 NJUPT MCP Server。
+
+## 配置步骤
+
+### 1. 找到配置文件
+
+Kimi Code CLI 的配置文件通常位于：
+
+- Windows: `%APPDATA%\kimi-cli\config.toml`
+- macOS/Linux: `~/.config/kimi-cli/config.toml`
+
+### 2. 添加 MCP 服务器配置
+
+#### stdio 模式（推荐）
+
+```toml
+[mcp.servers.njupt-mcp]
+type = "stdio"
+command = "uv"
+args = ["run", "--directory", "E:\\Code\\njupt-mcp", "njupt-mcp"]
+```
+
+如果使用 pip 安装：
+
+```toml
+[mcp.servers.njupt-mcp]
+type = "stdio"
+command = "python"
+args = ["-m", "njupt_mcp.server"]
+```
+
+#### SSE 模式
+
+首先启动服务器：
+
+```bash
+cd /path/to/njupt-mcp
+uv run njupt-mcp --transport sse --port 8000
+```
+
+然后在配置文件中添加：
+
+```toml
+[mcp.servers.njupt-mcp]
+type = "sse"
+url = "http://localhost:8000/sse"
+```
+
+### 3. 验证配置
+
+在 Kimi Code CLI 中输入：
+
+```
+/mcp
+```
+
+你应该能看到 `njupt-mcp` 服务器已列出。
+
+## 使用示例
+
+配置完成后，你可以在 Kimi Code CLI 中这样使用：
+
+```
+> 帮我查一下南京邮电大学数据结构的课程信息
+```
+
+Kimi Code CLI 会自动调用 `search_course` 工具。
+
+```
+> 帮我查一下学号 B21010101 的课表
+```
+
+这会调用 `get_course_schedule` 工具。
+
+## 故障排查
+
+### 服务器无法启动
+
+1. 检查 Python 版本：`python --version` 应 >= 3.11
+2. 检查依赖是否安装：`uv sync` 或 `pip install -e "."`
+3. 检查路径是否正确：确保 `--directory` 指向正确位置
+
+### MCP 命令无响应
+
+1. 检查 Kimi Code CLI 版本：`kimi --version`
+2. 查看 Kimi Code CLI 日志，通常在 `%APPDATA%\kimi-cli\logs\`
+3. 尝试手动运行服务器命令，查看是否有错误输出
+
+### 工具调用失败
+
+1. 确保服务器已正确启动
+2. 检查工具参数是否正确
+3. 查看服务器日志输出
+
+## 进阶配置
+
+### 环境变量
+
+你可以在配置中设置环境变量：
+
+```toml
+[mcp.servers.njupt-mcp]
+type = "stdio"
+command = "uv"
+args = ["run", "--directory", "E:\\Code\\njupt-mcp", "njupt-mcp"]
+env = { NJUPP_API_KEY = "your-api-key", DEBUG = "1" }
+```
+
+### 多个实例
+
+你可以配置多个服务器实例，分别用于不同环境：
+
+```toml
+[mcp.servers.njupt-mcp-dev]
+type = "stdio"
+command = "uv"
+args = ["run", "--directory", "E:\\Code\\njupt-mcp", "njupt-mcp", "--debug"]
+
+[mcp.servers.njupt-mcp-prod]
+type = "sse"
+url = "https://njupt-mcp.your-domain.com/sse"
+```