Onyx MCP Server

🚀 Onyx

Onyx は、組織内の知識の保存、検索、共有を目的とした強力な知識管理プラットフォームです。複数のインターフェースを通じてドキュメントにアクセスでき、強力な検索と集約機能を提供します。

🚀 クイックスタート

Onyx は、組織内の知識管理を効率化するために設計されたプラットフォームです。以下の手順を参照して、Onyx をインストールし、使用してください。

📦 インストール

npm install @lupuletic/onyx-mcp-server

💻 使用例

基本的な使用法

初期化

プロジェクトで Onyx を初期化します。

# 設定ファイルを作成
touch onyx.config.js

# デフォルト設定を初期化
npx onyx init

開発モードで実行

npm run dev

本番環境用のビルド

npm run build

コードのコミット

このプロジェクトは Conventional Commits 規約に従っています。手順を簡素化するために、対話型のコミットツールを提供しています。

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 タイトルは Conventional Commits 規約に従う必要があります。
   • PR タイトルはタイプで始まる必要があります（例：feat:、fix:、docs:）
   • この検証は PR の作成または更新時に自動的に行われます
   • 規約に沿わないタイトルの PR は失敗します
2. コミットメッセージの検証：すべてのコミットメッセージも Conventional Commits 形式に従う必要があります。
   • コミットメッセージはタイプで始まる必要があります（例：feat:、fix:、docs:）
   • これは git フックによってコミット時に実行されます
   • 規約に沿わないコミットは拒否されます
   • npm run commit を使用して対話型のコミットツールを利用できます
3. バージョン番号の増分の決定：
   • タイトルが feat で始まるか、新機能を含む PR → マイナーバージョンの増分
   • タイトルが fix で始まるか、バグ修正を含む PR → パッチバージョンの増分
   • タイトルに BREAKING CHANGE または感嘆符が含まれる PR → メジャーバージョンの増分
   • PR タイトルに具体的な増分が指定されていない場合は、コミットメッセージを分析します
   • コミットメッセージで見つかった最も高い優先度の増分を使用します（メジャー > マイナー > パッチ）
4. 自動リリース：
   • ブランチが main または master で終わる場合、バージョン番号が増分され、自動的に npm にプッシュされます

コントリビューションガイド

コードのコミット

すべてのコミットは Conventional Commits 規約に従い、テストに合格する必要があります。コミットする前に、コードが規約に沿っていることを確認してください。

問題の報告

問題が発生した場合は、こちらで報告してください：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

プロジェクトバッジ

コントリビューター

• Lupuletic：プロジェクト作者
• Contributors：その他のコントリビューター