Skip to Content
🚀 Gentoro OneMCP is open source!
DocumentationGetting Started

Getting Started

Install CLI

First, add the OneMCP bucket:

Create OneMCP Project

# Create a new project directory
mkdir ~/my-onemcp-project && cd ~/my-onemcp-project
 
# Initialize the project within the current directory
# Alternatively, you can run: onemcp init --project-dir ~/my-onemcp-project/
onemcp init

This command will initiate an interactive setup.

mkdir ~/my-onemcp-project && cd ~/my-onemcp-project
onemcp init
> How to run OneMCP?
  * Local
    Remote
 
> Which model to use?
  * OpenAI
    Gemini
    Anthropic
    Ollama
 
✅ Successfully initialized Local project at ~/my-onemcp-project/
📝 Next Steps (Provide Handbook Content):
   1). Add OpenAPI definitions to: ~/my-onemcp-project/handbook/apis/
       OneMCP supports OpenAPI 3.0.x and 3.1.x, in both YAML and JSON.
   2). Push your handbook: onemcp handbook push
       Once Handbook is complete, push to OneMCP. Its content will be:
          - Validate: Assert that your handbook is valid and can be served by OneMCP.
          - Indexed: Content will be ingested and populated into our Graph Contextual Search Engine.
          - Tested (Optional): In case regression-suite was configured, OneMCP will run tests against your handbook.
   3). Start chatting: onemcp chat
       Use our integrated interactive chat to send requests to OneMCP.
       Use your preferred MCP Client and connect with OneMCP Server URL: http://localhost:8080/mcp

Chat

By default, during setup, OneMCP will install an internal handbook that mimics an Analytics Server.

That enables users to directly test and see OneMCP in action right away.

> onemcp chat
 
╔══════════════════════════════════════╗
║     Gentoro OneMCP - Chat Mode       ║
╚══════════════════════════════════════╝
 
Handbook: ecommerce-api
Provider: openai
MCP URL: http://localhost:8080/mcp
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
💡 Mock Server Active - Try These Example Queries:
 
> Show me electronics sales in California last quarter.
> List top customers by revenue.
> Compare revenue trends by region.
 
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
Type your messages and press Enter to send.
Press Ctrl+C or type 'exit' to quit.
 
You: Show me the total revenue for 2024.
Agent: {
    "message": "Total revenue for 2024 calculated successfully.",
    "total_revenue": 5640255.26
}
 
Report: /Users/you/.onemcp/logs/reports/execution-2025-12-03T10-30-45.txt
 
> You:
Last updated on
IntroductionConcepts