Dust

🚀 MCP Server Guide

MCP Server is a tool for managing the Mission Control Protocol. It provides functions such as creating sessions, sending messages, and retrieving messages, and supports interaction through curl requests.

🚀 Quick Start

✨ Features

• Manage Mission Control Protocol tasks.
• Create, send, and retrieve conversation messages.
• Support configuration via config.json and environment variables.
• Provide command - line options for server startup and logging.

📦 Installation

To install MCP Server, follow these steps:

Prerequisites

• Operating System: Linux, macOS, or Windows (Linux is recommended).
• Python Version: 3.6 or higher.
• Git: Used to clone the code repository.

Clone the Repository

Run the following command to clone the MCP Server repository:

git clone https://github.com/yourusername/mcp-server.git
cd mcp-server

Install Dependencies

Use pip to install the required Python packages:

pip install -r requirements.txt

Start the Server

After installation, run the following command to start MCP Server:

python3 server.py --help

💻 Usage Examples

Configuration

The configuration of MCP Server is done through the config.json file, which is located in the project's root directory.

Example Configuration

{
  "server": {
    "host": "0.0.0.0",
    "port": 5000,
    "debug": true
  },
  "api_key": "your_api_key_here",
  "workspace_id": "your_workspace_id_here"
}

Environment Variables

MCP Server supports configuration via environment variables. The following are commonly used environment variables:

• MCP_API_KEY: Your API key.
• MCP_WORKSPACE_ID: Your workspace ID.
• MCP_DEBUG: Enable debug mode (true or false).

Command - Line Options

MCP Server provides the following command - line options:

Start the Server

python3 server.py --host HOST --port PORT [--debug]

Parameters

• --host: The host address to which the server binds (default: 0.0.0.0).
• --port: The port on which the server listens (default: 5000).
• --debug: Enable debug mode (default: false).

Logging

python3 server.py --log-file LOG_PATH [--log-level LEVEL]

Parameters

• LOG_PATH: The path to the log file.
• LEVEL: The log level (DEBUG, INFO, WARNING, ERROR, CRITICAL, default: INFO).

Example curl Requests

Create a Session

curl -X POST "http://localhost:5000/api/v1/conversations" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "System Thinking Conversation",
    "model": "claude-3-5-sonnet-20240620"
  }'

Send a Message

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Explain the detailed information of the MCP protocol",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "Time Zone": "Europe/Berlin",
        "Model Settings": {"Provider": "anthropic"}
      }
    }],
    "context": {
      "Time Zone": "Europe/Berlin"
    }
  }'

Retrieve Messages

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Return all messages",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "Time Zone": "Europe/Berlin",
        "Model Settings": {"Provider": "anthropic"}
      }
    }]
  }'

📚 Documentation

Error Handling

MCP Server supports the following error codes:

• 400 Bad Request: Invalid request.
• 401 Unauthorized: Unauthorized access.
• 404 Not Found: Resource not found.
• 500 Internal Server Error: Server internal error.

Contribution Guide

Submit an Issue

Submit an issue in the GitHub repository to report problems or propose suggestions.

Submit a Feature Request

Submit new features or improvements through a Pull Request.

⚠️ Important Note

• Ensure the security of your API key and workspace ID to avoid leakage.
• Disable debug mode in a production environment.

📚 MCP Server API Documentation

🚀 Quick Start

MCP Server provides a RESTful API that allows clients to interact with the MCP service. The following are the available API endpoints and their detailed descriptions.

💻 Usage Examples

Create a Session

POST /api/v1/conversations

• Description: Create a new conversation session.
• Request Headers:
  • Authorization: Bearer Token (required).
  • Content-Type: application/json.
• Request Body:

{
  "title": "string", // Title of the conversation (optional)
  "model": "string" // Model to use (required)
}

• Response:

{
  "id": "string", // ID of the newly created session
  "title": "string",
  "created_at": "datetime"
}

Send a Message

POST /api/v1/conversations/{conversation_id}/messages

• Description: Send a new message to the specified conversation session.
• Request Headers:
  • Authorization: Bearer Token (required).
  • Content-Type: application/json.
• Request Body:

{
  "content": "string", // Message content (required)
  "mentions": array // Mentioned users or roles (optional)
}

• Response:

{
  "id": "string",
  "content": "string",
  "sent_at": "datetime"
}

Retrieve Messages

POST /api/v1/conversations/{conversation_id}/messages

• Description: Retrieve all messages in the specified conversation session.
• Request Headers:
  • Authorization: Bearer Token (required).
  • Content-Type: application/json.
• Request Body:

{
  "content": "string", // Query condition, e.g., "Return all messages" (required)
  "mentions": array // Mentioned users or roles (optional)
}

• Response:

[
  {
    "id": "string",
    "content": "string",
    "sent_at": "datetime"
  },
  ...
]

Example curl Requests

Create a Session

curl -X POST "http://localhost:5000/api/v1/conversations" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "System Thinking Conversation",
    "model": "claude-3-5-sonnet-20240620"
  }'

Send a Message

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Explain the detailed information of the MCP protocol",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "Time Zone": "Europe/Berlin",
        "Model Settings": {"Provider": "anthropic"}
      }
    }]
  }'

Retrieve Messages

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Return all messages",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "Time Zone": "Europe/Berlin",
        "Model Settings": {"Provider": "anthropic"}
      }
    }]
  }'