Onyx MCP Server

🚀 Onyx

Onyx is a powerful knowledge management platform designed for internal knowledge storage, retrieval, and sharing within organizations. It supports accessing documents through various interfaces and offers robust search and aggregation capabilities.

🚀 Quick Start

Onyx is a knowledge management platform that simplifies knowledge storage, retrieval, and sharing within organizations. It provides multiple interfaces for accessing documents and powerful search and aggregation features.

📦 Installation

npm install @lupuletic/onyx-mcp-server

💻 Usage Examples

Basic Usage

Initialization

Initialize Onyx in your project:

# Create a configuration file
touch onyx.config.js

# Initialize default settings
npx onyx init

Run in Development Mode

npm run dev

Build for Production

npm run build

Commit Code

This project follows the Conventional Commits specification. To simplify the process, we provide an interactive commit tool:

npm run commit

You can also manually write commit messages in the following format:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Where <type> can be: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert

Testing

Run the test suite:

npm test

Run tests with coverage:

npm run test:coverage

Code Style

npm run lint

Fix code style issues:

npm run lint:fix

Advanced Usage

Continuous Integration

This project uses GitHub Actions for continuous integration and deployment. The CI pipeline runs on every push and pull request to the main branch, performing the following checks:

• Code style
• Build
• Testing
• Coverage report

Automatic Version Increment and Release

When a PR is merged into the main branch, the project automatically determines the appropriate version increment and publishes it to npm. The system decides the version increment by analyzing the PR title and commit messages:

1. PR Title Validation: All PR titles must follow the Conventional Commits specification:

   • PR titles must start with a type (e.g., feat:, fix:, docs:)
   • This validation is performed automatically when creating or updating a PR
   • PRs with non-compliant titles will fail

2. Commit Message Validation: All commit messages must also follow the Conventional Commits format:

   • Commit messages must start with a type (e.g., feat:, fix:, docs:)
   • This is enforced by a git hook when you commit
   • Non-compliant commits will be rejected
   • Use npm run commit for an interactive commit tool

3. Version Increment Determination:

   • PRs with titles starting with feat or containing new features → Minor version increment
   • PRs with titles starting with fix or containing bug fixes → Patch version increment
   • PRs with titles containing BREAKING CHANGE or an exclamation mark → Major version increment
   • If the PR title does not specify a version increment, the commit messages are analyzed
   • The highest priority increment found in the commit messages is used (Major > Minor > Patch)

4. Automatic Release:

   • When a branch ends with main or master, the version is incremented and automatically published to npm

🤝 Contribution Guidelines

Submitting Code

All submissions must follow the Conventional Commits specification and pass the tests. Please ensure your code adheres to the style guide before submitting.

Creating Issues

If you encounter any issues, please report them here: Issues

📋 Use Cases

Onyx can be applied in the following scenarios:

• Knowledge Base Management: Centralize the storage and management of organizational knowledge assets.
• Document Collaboration: Support multiple users in collaboratively writing and updating documents.
• Information Retrieval: Quickly find the required information through powerful search capabilities.
• Team Collaboration Tool: Integrate into existing development workflows to improve work efficiency.

🏗️ Project Structure

Core Modules

• onyx-engine: The knowledge engine responsible for document storage and retrieval.
• onyx-ui: The user interface providing an intuitive operating experience.
• onyx-cli: The command-line tool for developers to use Onyx conveniently.

Extension Plugins

Onyx offers a flexible plugin system that allows you to extend its functionality. The following plugins are currently supported:

• git-plugin: Integrates with Git to support document management via Git.
• search-plus: Enhances the search functionality by providing smarter result sorting.
• auth-plugin: An authentication plugin supporting multiple authentication methods.

Development Guide

Install Dependencies

npm install

Start the Development Server

npm run dev

Build the Project

npm run build

📊 Project Badges

👥 Contributors

• Lupuletic: Project author
• Contributors: Other contributors