0g

The 0G MCP Server exposes a set of tools to interact with 0G.AI documentation, code examples, and storage/compute capabilities through the MCP protocol. It provides capabilities to browse documentation (0gDocs), extract code examples (0gExamples), and perform storage and compute related operations via the integrated 0G Storage and 0G Compute Network tooling. Use the configured MCP client (Claude Code, Cursor, Windsurf, or other MCP clients) to add the 0g-docs server entry and then issue structured requests to fetch docs, pull code samples, or perform actions like uploading to 0G Storage or listing available AI services on 0G Compute Network. The server demonstrates a practical workflow for discovering SDK guides, retrieving example implementations, and interacting with 0G services through a unified MCP interface.

Prerequisites:

• A working development environment with Bun installed (bun.sh).
• Git installed for submodule handling.
• Access to the 0g-mcp-server repository (or clone it).

1. Install Bun (if not already installed):

   • macOS/Linux: curl https://bun.sh/install | bash
   • Windows: follow Bun's Windows install instructions

2. Clone the MCP server repository: git clone https://github.com/your-org/0g-mcp-server.git cd 0g-mcp-server

3. Install dependencies: bun install

4. Initialize and update submodules (documentation submodules): bun run prepare-docs git submodule update --init --recursive

5. Start the server (development): bun run start

6. (Optional) Run in development mode with hot reload: bun run dev

7. Configure MCP client connection:

   • Add to your MCP client configuration the server entry (see mcp_config example below).
   • Restart your MCP client or reconnect to apply the new server.

Notes and tips:

• The server uses Bun; ensure Bun is available in your environment where the MCP client runs.
• The provided mcp_config uses a placeholder path (/path/to/0g-mcp-server/src/stdio.ts). Replace it with the actual path where your MCP server entry file resides.
• If you deploy in production, consider pinning Bun versions and locking dependencies to stable releases.
• Environment variables for private keys or indexer RPCs are not required for read-only docs access, but storage and write operations require OG_PRIVATE_KEY or a provided privateKey parameter (as described in the 0gStorage tools).