Onyx MCP Server

🚀 Onyx

Onyx 是一款功能強大的知識管理平臺，專為組織內部的知識存儲、檢索和共享量身打造。它支持通過多種接口訪問文檔，還具備強大的搜索和聚合功能，能有效提升知識管理的效率。

🚀 快速開始

Onyx 是一款強大的知識管理平臺，可幫助您輕鬆實現組織內部的知識存儲、檢索和共享。以下是使用 Onyx 的基本步驟：

1. 安裝 Onyx 依賴。
2. 初始化 Onyx 配置。
3. 啟動開發服務器或進行生產環境構建。

✨ 主要特性

• 多接口訪問：支持通過多種接口訪問文檔，方便快捷。
• 強大搜索與聚合：提供強大的搜索和聚合功能，能快速定位所需知識。
• 靈活插件系統：支持擴展插件，可根據需求定製功能。
• 多人協作：支持多人協作編寫和更新文檔，提升團隊協作效率。

📦 安裝指南

使用以下命令安裝 Onyx：

npm install @lupuletic/onyx-mcp-server

💻 使用示例

基礎用法

初始化

在您的項目中初始化 Onyx：

# 創建配置文件
touch onyx.config.js

# 初始化默認設置
npx onyx init

開發模式運行

npm run dev

生產環境構建

npm run build

提交代碼

該項目遵循 約定式提交 規範。為了簡化流程，我們提供了一個交互式的提交工具：

npm run commit

您也可以手動編寫符合以下格式的提交信息：

<類型>[可選範圍]: <描述>

[可選主體]

[可選註腳]

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

測試

運行測試套件：

npm test

帶有覆蓋率的測試：

npm run test:coverage

代碼規範

npm run lint

修復代碼規範問題：

npm run lint:fix

高級用法

持續集成

該項目使用 GitHub Actions 進行持續集成和部署。CI 管道在每個主分支的推送和拉取請求上運行，執行以下檢查：

• 代碼規範
• 構建
• 測試
• 覆蓋率報告

自動版本號遞增與發佈

當 PR 合併到主分支時，項目會自動確定適當的版本號遞增量並將其發佈到 npm。該系統通過分析 PR 標題和提交信息來決定版本號遞增量：

1. PR 標題驗證：所有 PR 標題都必須符合 約定式提交 規範：

   • PR 標題必須以類型開頭（例如 feat:、fix:、docs:）
   • 此驗證在創建或更新 PR 時自動進行
   • 標題不符合規範的 PR 將會失敗

2. 提交信息驗證：所有提交信息也必須符合約定式提交格式：

   • 提交信息必須以類型開頭（例如 feat:、fix:、docs:）
   • 這通過 git 鉤子在您提交時執行
   • 不符合規範的提交將被拒絕
   • 使用 npm run commit 獲取交互式提交工具

3. 版本號遞增量確定：

   • 標題以 feat 或包含新功能的 PR → 次版本遞增
   • 標題以 fix 或包含錯誤修復的 PR → 修訂版本遞增
   • 標題包含 BREAKING CHANGE 或感嘆號的 PR → 主版本遞增
   • 如果 PR 標題沒有指定具體的遞增量，則分析提交信息
   • 使用提交信息中找到的最高優先級遞增量（主 > 次 > 修訂）

4. 自動發佈：

   • 當分支以 main 或 master 結束時，版本號將被遞增並自動推送到 npm

📚 詳細文檔

貢獻指南

提交代碼

所有提交必須遵循 約定式提交 規範，並且通過測試。請在提交前確保代碼符合規範。

創建問題

如果您遇到任何問題，請在這裡報告：Issues

使用場景

Onyx 可以應用於以下場景：

• 知識庫管理：集中存儲和管理組織的知識資產。
• 文檔協作：支持多人協作編寫和更新文檔。
• 信息檢索：通過強大的搜索功能快速找到所需信息。
• 團隊協作工具：集成到現有的開發流程中，提升工作效率。

項目結構

核心模塊

• onyx-engine：知識引擎，負責處理文檔的存儲和檢索。
• onyx-ui：用戶界面，提供直觀的操作體驗。
• onyx-cli：命令行工具，方便開發者使用 Onyx。

擴展插件

Onyx 提供了一個靈活的插件系統，允許您擴展其功能。目前支持以下插件：

• git-plugin：與 Git 集成，支持通過 Git 進行文檔管理。
• search-plus：增強搜索功能，提供更智能的結果排序。
• auth-plugin：身份驗證插件，支持多種認證方式。

開發指南

安裝依賴

npm install

啟動開發服務器

npm run dev

構建項目

npm run build

🔧 技術細節

該項目使用 GitHub Actions 實現持續集成和部署，通過分析 PR 標題和提交信息來自動確定版本號遞增量併發布到 npm。同時，項目遵循約定式提交規範，確保代碼提交的規範性和可維護性。

📄 許可證

文檔中未提及許可證相關信息。

項目徽章

貢獻者

• Lupuletic：項目作者
• Contributors：其他貢獻者