🚀 MCP Server Setup Guide

Learn how to connect Oshaani MCP Server to your favorite AI agents

📑 Table of Contents

1. Overview

The Oshaani MCP (Model Context Protocol) Server provides powerful tools and capabilities that can be integrated into various AI agents. This server exposes agent management, conversation handling, and other features through a standardized MCP interface.

🌐 Server URL:
https://mcp.oshaani.com
Main Endpoint: /mcp
Health Check: /health

What You Can Do

2. Getting Your API Key

To use the MCP server, you need an API key for authentication. Follow these steps:

1 Log in to Oshaani Platform

Visit https://oshaani.com and log in to your account.

2 Navigate to Profile Settings

Go to your profile page and find the API Key section.

3 Generate or Copy Your API Key

If you don't have an API key yet, generate one. Copy it securely - you'll need it for configuration.

⚠️ Security Note: Keep your API key secure and never share it publicly. Treat it like a password. If compromised, regenerate it immediately.

3. Adding to Cursor Recommended

Cursor is a popular AI-powered code editor that supports MCP servers. Here's how to add the Oshaani MCP server:

1 Open Cursor Settings

Open Cursor and go to Settings → Features → MCP Servers or edit the MCP configuration file directly.

2 Edit MCP Configuration

Open or create the MCP configuration file. The location depends on your OS:

  • macOS: ~/Library/Application Support/Cursor/User/globalStorage/mcp.json
  • Windows: %APPDATA%\Cursor\User\globalStorage\mcp.json
  • Linux: ~/.config/Cursor/User/globalStorage/mcp.json
3 Add Server Configuration

Add the following configuration to your MCP servers:

{
  "mcpServers": {
    "oshaani-agent-api": {
      "url": "https://mcp.oshaani.com/mcp",
      "headers": {
        "Authorization": "ApiKey YOUR_API_KEY_HERE"
      }
    }
  }
}
4 Replace API Key

Replace YOUR_API_KEY_HERE with your actual API key from step 2.

5 Restart Cursor

Restart Cursor to load the new MCP server configuration.

✅ Verification: After restarting, you should see the Oshaani MCP server listed in Cursor's MCP servers panel. The tools and capabilities should be available for use.

4. Adding to Claude Desktop

Claude Desktop (Anthropic's official app) supports MCP servers through configuration files.

1 Locate Claude Config File

Find your Claude Desktop configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
2 Edit Configuration

Open the config file and add the MCP server configuration:

{
  "mcpServers": {
    "oshaani-agent-api": {
      "url": "https://mcp.oshaani.com/mcp",
      "headers": {
        "Authorization": "ApiKey YOUR_API_KEY_HERE"
      }
    }
  }
}
3 Replace API Key

Replace YOUR_API_KEY_HERE

4 Restart Claude Desktop

Close and reopen Claude Desktop to load the new configuration.

5. Other MCP-Compatible Agents

The Oshaani MCP server follows the Model Context Protocol specification and should work with any MCP-compatible client. Here's a generic configuration:

Generic MCP Configuration

{
  "mcpServers": {
    "oshaani-agent-api": {
      "url": "https://mcp.oshaani.com/mcp",
      "headers": {
        "Authorization": "ApiKey YOUR_API_KEY_HERE"
      }
    }
  }
}

Supported Agents

💡 Tip: If your agent/client supports MCP but uses a different configuration format, check their documentation. The key information you need is:
  • Server URL: https://mcp.oshaani.com/mcp
  • Authentication: API key in headers (see Authentication Methods below)

6. Authentication Methods

The Oshaani MCP server supports multiple authentication methods. You can use any of the following:

Method 1: Authorization Header (ApiKey)

Authorization: ApiKey YOUR_API_KEY_HERE

Method 2: Authorization Header (Bearer)

Authorization: Bearer YOUR_API_KEY_HERE

Method 3: X-API-Key Header

X-API-Key: YOUR_API_KEY_HERE
📝 Note: For MCP configuration files, use the headers object to include authentication. The ApiKey format is recommended for consistency.

7. Testing Your Connection

After configuring your MCP client, you can test the connection using these methods:

Method 1: Health Check Endpoint

Test if the server is accessible:

curl https://mcp.oshaani.com/health

Method 2: Test MCP Endpoint (with API Key)

curl -H "Authorization: ApiKey YOUR_API_KEY_HERE" \
     https://mcp.oshaani.com/mcp

Method 3: Check in Your MCP Client

Most MCP clients will show:

✅ Success Indicators:
  • Server appears as "connected" in your MCP client
  • Tools and resources are listed and available
  • You can execute MCP operations without errors

8. Troubleshooting

Connection Issues

Problem: Cannot connect to MCP server
Solutions:
  • Verify the URL is correct: https://mcp.oshaani.com/mcp
  • Check your internet connection
  • Ensure DNS is resolving correctly
  • Check if the server is running (use health check endpoint)

Authentication Errors

Problem: 401 Unauthorized or authentication failed
Solutions:
  • Verify your API key is correct (no extra spaces)
  • Check that the Authorization header format is correct
  • Ensure your API key hasn't been revoked or expired
  • Try regenerating your API key from the Oshaani platform

SSL/TLS Certificate Warnings

Problem: Certificate warnings in browser or client
Note: If you see certificate warnings, the server may be using a temporary self-signed certificate. This is normal during initial setup. For production use, ensure a valid Let's Encrypt certificate is installed.

MCP Client Not Recognizing Server

Problem: MCP client doesn't show the server or tools
Solutions:
  • Restart your MCP client after configuration changes
  • Verify the JSON configuration is valid (check for syntax errors)
  • Check client logs for error messages
  • Ensure your client supports HTTP/SSE transport (not just STDIO)

Getting Help

If you continue to experience issues:

  • Check the server logs: /var/log/mcp-server/
  • Check nginx logs: /var/log/nginx/mcp_oshaani_com_error.log
  • Contact support through the Oshaani platform
  • Review the MCP specification: modelcontextprotocol.io

Oshaani MCP Server Guide

Server URL: https://mcp.oshaani.com | Platform: oshaani.com