使用说明
知识库MCP服务器
该项目实现了一个模型上下文协议(MCP)服务器,该服务器提供了通过API交互管理知识库的工具。它允许AI助手在您的知识库中创建、更新和搜索笔记。
概述
知识库MCP服务器提供以下功能:
- 添加带有标题、内容和标签的新笔记
- 更新现有笔记
- 通过在标题或内容中搜索关键字来查找笔记ID
该服务器充当人工智能助手和您的知识库API之间的桥梁,实现与笔记数据库的结构化交互。
先决条件
- Node.js(建议使用v14或更高版本)
- npm或纱线
- 正在运行的API服务器
http://localhost:3000提供笔记管理功能
安装
- 克隆此存储库
- 安装依赖项:或
npm installyarn install
依赖项
此项目依赖于以下软件包:
@modelcontextprotocol/sdk-模型上下文协议SDKaxios-用于向知识库API发出HTTP请求zod-用于模式验证
构建服务器
使用构建服务器
npm run build
运行服务器
使用以下命令启动服务器:
node index.js
服务器将在stdio上运行,允许它与实现MCP客户端协议的客户端通信。
测试您的服务器 使用Claude for Desktop测试您的MCP服务器:
遵循Anthropic的指南: 使用Claude for Desktop测试您的服务器
本指南将引导您完成将MCP服务器连接到Claude并验证工具是否正常工作的过程。
可用工具
1.添加注释
在知识库中创建新笔记。
参数:
title(string):注释的标题content(string):注释内容tags(array):标签对象数组id,name,以及color属性
2.update_note
更新知识库中的现有注释。
参数:
id(string):要更新的笔记的IDtitle(字符串,可选):注释的新标题content(字符串,可选):注释的新内容tags(数组,可选):注释的新标签
3.查找note_id_by_keyword
搜索标题或内容中包含特定关键字的笔记。
参数:
keyword(string):在笔记标题或内容中搜索的关键字
API集成
此服务器需要API知识库运行在 http://localhost:3000 具有以下端点:
POST /api/notes-创建新笔记PUT /api/notes/:id-更新现有注释GET /api/notes-获取所有笔记
注释结构
知识库中的注释具有以下结构:
interface Note {
id: string;
title: string;
content: string;
tags: Array<{
id: string;
name: string;
color: string;
notesCount?: number;
}>;
updatedAt: string;
}
错误处理
服务器包括API请求的错误处理。如果发生错误,它将被记录到控制台并在工具响应中返回。
许可证
[您的许可证在这里]
贡献
[此处为您的贡献指南]
