Onyx FAQs

Question 1

How can I use Onyx to find code examples?

Accepted Answer

Onyx includes GitHub integration. You can search code examples by topic using `search_github_examples`, find function definitions with `get_onyx_functions`, and list available repositories with `list_github_repos`.

Question 2

Is the Onyx MCP interface read-only?

Accepted Answer

Yes, the MCP interface is read-only. This ensures security and separation of concerns by preventing accidental data modification or crawling actions through the MCP tools.

Question 3

Can I contribute to the Onyx data collection?

Accepted Answer

Data crawling is done via CLI commands, not through the MCP interface, ensuring a separation of data collection and query functionality. The crawling process populates the data/ directory that Onyx searches.

Question 4

How do I connect Onyx to Claude Desktop?

Accepted Answer

You can connect to Onyx using either a local MCP server or a hosted server via a bridge. Configuration details for both methods are provided in the documentation.

Question 5

What is Onyx and what does it do?

Accepted Answer

Onyx is a tool that allows you to search and query Onyx programming language documentation and GitHub code examples. It provides a unified search across all data sources, making it easy to find the information you need.

Onyx

주요 기능

사용 사례

Onyx

주요 기능

사용 사례