1.0.6 • Published 5 months ago

@holder-mcp/local-knowledge-base v1.0.6

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months ago

@holder-mcp/local-knowledge-base

Holder公司本地知识库MCP(Model Context Protocol)客户端,提供项目文档检索、模块信息查询和架构信息获取等工具。

🚀 功能特性

  • 项目文档检索 - 基于语义搜索的智能文档查询
  • 模块信息查询 - 获取特定模块的设计文档和历史逻辑
  • 架构信息获取 - 查看项目架构设计和技术选型
  • 代码文档搜索 - 专门针对代码相关文档的搜索
  • 知识库统计 - 获取知识库的统计信息和状态

📦 安装

通过NPM私服安装

npm install -g @holder-mcp/local-knowledge-base --registry http://npm.holderzone.cn/

或直接使用npx

npx @holder-mcp/local-knowledge-base@latest --registry http://npm.holderzone.cn/

🔧 配置使用

在Cursor IDE中配置

在Cursor的设置中添加MCP服务器配置:

{
  "mcpServers": {
    "holder-knowledge-base": {
      "command": "npx",
      "args": [
        "-y", 
        "@holder-mcp/local-knowledge-base",
        "--registry", "http://npm.holderzone.cn/"
      ],
      "description": "Holder本地知识库"
    }
  }
}

自定义服务器地址

如果知识库服务器不在默认地址,可以指定:

{
  "mcpServers": {
    "holder-knowledge-base": {
      "command": "npx",
      "args": [
        "-y", 
        "@holder-mcp/local-knowledge-base",
        "--registry", "http://npm.holderzone.cn/",
        "--server-url", "http://your-server:8888"
      ]
    }
  }
}

🛠️ 可用工具

1. queryKnowledgeBase

根据用户查询从本地知识库检索相关信息。

参数:

  • query (string) - 查询内容
  • topK (integer) - 返回结果数量,默认5

示例:

查询Spring AI的使用方法

2. getModuleInfo

检索特定模块或功能的历史逻辑和设计规范。

参数:

  • moduleName (string) - 模块名称

示例:

用户管理模块

3. getArchitectureInfo

获取项目架构信息和设计模式。

参数:

4. getKnowledgeBaseStats

获取知识库的统计信息。

参数:

5. searchCodeDocumentation

专门搜索代码相关的文档和实现细节。

参数:

  • codeQuery (string) - 代码查询内容

示例:

用户认证相关的实现

🔍 使用示例

安装配置完成后,在Cursor中可以这样使用:

  • "帮我查找项目中关于Spring AI的文档"
  • "获取用户管理模块的设计信息"
  • "显示这个项目的架构信息"
  • "搜索代码中关于认证的实现"
  • "知识库有多少文档"

🖥️ 命令行使用

也可以直接在命令行使用:

# 启动MCP客户端
holder-mcp-kb

# 使用自定义服务器地址
holder-mcp-kb --server-url http://custom-server:8888

# 查看帮助
holder-mcp-kb --help

⚙️ 配置选项

选项描述默认值
--server-url知识库服务器地址http://localhost:8888
--help显示帮助信息-

🔧 开发

构建项目

cd client
npm install
npm run build

发布到私服

npm publish --registry http://npm.holderzone.cn/

📝 版本历史

v1.0.0

  • 初始版本
  • 支持5个核心工具功能
  • 标准MCP协议实现
  • 支持自定义服务器地址

🐛 问题反馈

如有问题,请联系开发团队或提交issue。

�� 许可证

MIT License

1.0.6

5 months ago

1.0.4

5 months ago

1.0.3

5 months ago

1.0.2

5 months ago

1.0.1

5 months ago

1.0.0

5 months ago