article
README
🚀 Kibela MCP 服务器
Kibela MCP 服务器是一个开源项目,遵循模型上下文协议(Model Context Protocol),致力于搭建 AI 工具与 Kibela 笔记服务之间的桥梁。借助该服务器,AI 模型能借助 HTTP 协议对 Kibela 中的笔记数据进行访问和操作。
✨ 主要特性
- 搜索笔记:支持通过关键词或条件查询笔记内容。
- 创建与更新笔记:允许 AI 工具生成、编辑和管理笔记。
- 评论交互:AI 可以添加和回复笔记中的评论,增强互动性。
- 文件管理:支持附件上传及关联,提升笔记的扩展能力。
- 安全审计:确保所有操作符合安全规范,保障数据完整性。
🔧 技术细节
核心组件
工具定义
以下是 MCP 服务器中预设的关键工具及其功能描述:
- 搜索笔记
- 功能:通过关键字或筛选条件查找特定笔记。
- 输入格式:支持自由文本输入和结构化查询参数。
- 输出格式:返回匹配笔记的基本信息及内容摘要。
- 创建新笔记
- 功能:生成新的空白笔记,可指定标题、内容及所属组别。
- 输入格式:包含标题、正文和组别标识的 JSON 对象。
- 输出格式:返回新建笔记的唯一标识符和链接地址。
- 更新现有笔记
- 功能:对已存在的笔记进行内容修改或扩展。
- 输入格式:包括笔记 ID 和需要更新的内容片段。
- 输出格式:确认更新操作成功的状态信息。
- 添加评论
- 功能:在指定笔记下添加新的评论内容。
- 输入格式:包含评论文本和目标笔记 ID 的数据包。
- 输出格式:返回新评论的详细信息及关联笔记链接。
操作指南
- 安装依赖
docker compose run mcp pnpm install
- 启动服务
docker compose up
- 配置环境变量
- 设置
KIBELA_ORIGIN为你的 Kibela 实例地址。 - 配置
KIBELA_ACCESS_TOKEN用于身份验证。
- 设置
- 挂载配置文件(可选)
docker compose exec mcp bin/cli.mjs \
--config=/path/to/your/config.json
自定义配置
通过编写自定义工具描述和提示文件,可以进一步扩展服务器功能。具体步骤如下:
- 创建一个 JSON 文件,例如
custom-config.json:
{
"tools": {
"search_kibela_note": {
"description": "根据关键词搜索笔记内容"
}
},
"prompts": {
"review": {
"prompt": "分析并总结指定链接中的笔记内容,提出改进建议。"
}
}
}
- 将此配置文件挂载到 Docker 容器中:
docker run -v /path/to/custom-config.json:/config.json kibela-mcp-server
测试验证
使用 MCP Inspector 工具对服务器进行功能测试:
npx mcp-inspector \
--origin http://localhost:3000 \
--token your-access-token
📄 许可证
本项目采用 MIT 协议,允许自由使用、修改和分发。
扫码联系在线客服