Lupuletic Onyx MCP Server

🚀 Onyx MCP Server

Onyx is a language model-based Q&A system designed for rapid document search and understanding within enterprises. It supports enhanced functionality through custom rule plugins and can integrate with open-source large language models like LlamaCpp.

🚀 Quick Start

📦 Installation

Install using npm:

npm install onyx-mcp-server

⚙️ Configuration

Create a configuration file config.json as follows:

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

💻 Usage Examples

Start the server

npm start -- --config config.json

Send a query request to 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?"}'

🔧 Development

Run in development mode

npm run dev

Commit changes

This project follows the Conventional Commits specification. To simplify the commit 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.

Production build

npm run build

🧪 Testing

Run the test suite

npm test

Test with coverage

npm run test:coverage

📋 Format Checking

Check format

npm run lint

Fix format errors

npm run lint:fix

🛠️ Continuous Integration

This project uses GitHub Actions for continuous integration and deployment. The CI pipeline runs when code is pushed to the main branch or a pull request is created, performing the following checks:

• Format checking
• Build
• Testing
• Code coverage reporting

Automatic Version Increment and Release

When a PR is merged into the main branch, the system automatically determines the appropriate version increment type and publishes to npm. The process analyzes the PR title and commit messages to decide the version increment type:

1. PR title verification: All PR titles must follow the Conventional Commits specification:
   • The PR title must start with a type (e.g., feat:, fix:, docs:).
   • This verification is automatically performed when creating or updating a PR.
   • Non-compliant PRs will fail.
2. Commit message verification: All commit messages must also follow the conventional commit format:
   • The commit message must start with a type (e.g., feat:, fix:, docs:).
   • This is enforced by git hooks when you commit.
   • Non-compliant commits will be rejected.
   • Use npm run commit to get the interactive commit tool.
3. Version increment determination: The system analyzes the PR title and commit messages to decide the version increment type:
   • PRs with titles starting with feat or containing new features → Increment the major version number.
   • PRs with titles starting with fix or containing bug fixes → Increment the patch version number.
   • Other cases → Increment the build version number.
4. Publish to npm: Based on the determined version type, the following commands are automatically executed:

   git tag <version number>
   git push --tags
   npm publish
   

🤝 Contribution Guidelines

Submit code

Please follow these steps to submit code:

1. Create a new feature branch based on the main branch:

   git checkout -b feature/your-feature main
   

2. Commit your changes and run all checks:

   npm run lint && npm test
   

3. Push to your repository and create a pull request.

Report issues

Submit issues on the GitHub Issues page.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Gitee Mirror