Lupuletic Onyx MCP Server

🚀 Onyx MCP 服务器

Onyx 是一个基于语言模型的问答系统，专为企业内部文档的快速搜索与理解而设计。它不仅支持通过自定义规则插件增强功能，还能与 LlamaCpp 等开源大语言模型集成。

🚀 快速开始

Onyx 作为基于语言模型的问答系统，可助力企业快速搜索和理解内部文档，还能借助插件增强功能并与开源大模型集成。

📦 安装指南

使用 npm 进行安装：

npm install onyx-mcp-server

📚 详细文档

配置

创建一个配置文件 config.json，如下所示：

{
  "port": 3001,
  "api_key": "your_api_key",
  "document_store": {
    "type": "local",
    "path": "./documents"
  },
  "llm": {
    "model_path": "/path/to/llama/model",
    "n_ctx": 2048
  }
}

使用示例

基础用法

启动服务器：

npm start -- --config config.json

向 Onyx 发送查询请求：

curl -X POST http://localhost:3001/api/v1/query \
  -H "Content-Type: application/json" \
  -d '{"query": "What is our latest policy on remote work?"}'

开发

运行开发模式

npm run dev

提交更改

该项目遵循 Conventional Commits 规范。为了简化提交流程，我们提供了一个交互式提交工具：

npm run commit

你也可以手动编写符合以下格式的提交信息：

<类型>[可选范围]: <描述>

[可选主体]

[可选注释]

其中 <类型> 可以是：feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert。

生产构建

npm run build

测试

运行测试套件：

npm test

带有覆盖率的测试：

npm run test:coverage

格式检查

npm run lint

修复格式错误：

npm run lint:fix

持续集成

该项目使用 GitHub Actions 进行持续集成和部署。CI 管道在将代码推送到主分支或创建拉取请求时运行，执行以下检查：

• 格式检查
• 构建
• 测试
• 代码覆盖率报告

自动版本递增与发布

当 PR 被合并到主分支时，系统会自动确定合适的版本递增类型并发布到 npm。该过程分析了 PR 标题和提交信息来决定版本递增类型。

1. PR 标题验证：所有 PR 标题必须符合 Conventional Commits 规范：
   • PR 标题必须以类型开头（例如 feat:、fix:、docs:）
   • 该验证在创建或更新 PR 时自动进行
   • 不符合规范的 PR 将会失败
2. 提交信息验证：所有提交信息也需符合常规提交格式：
   • 提交信息必须以类型开头（例如 feat:、fix:、docs:）
   • 这通过 git 钩子在你提交时执行
   • 不符合规范的提交将被拒绝
   • 使用 npm run commit 获取交互式提交工具
3. 版本递增确定：系统分析 PR 标题和提交信息来决定版本递增类型：
   • 标题以 feat 或包含新功能的 PR → 递增主版本号
   • 标题以 fix 或包含修复的 PR → 递增修订版本号
   • 其他情况 → 递增构建版本号
4. 发布到 npm：根据确定的版本类型，自动执行以下命令：

   git tag <版本号>
   git push --tags
   npm publish
   

贡献指南

提交代码

请遵循以下步骤提交代码：

1. 创建基于 main 分支的新功能分支：

   git checkout -b feature/your-feature main
   

2. 提交更改并运行所有检查：

   npm run lint && npm test
   

3. 推送到你的仓库并创建拉取请求。

问题报告

在 GitHub Issues 页面提交问题。

📄 许可证

本项目遵循 MIT 许可证。请查看 LICENSE 文件获取详细信息。

Gitee 镜像地址