Simple OpenAI Assistant

by andybrandt

24 stars
8.7k downloads
Not rated
GitHub

About

A simple server for interacting with OpenAI assistants using an API key.

Details

Author
andybrandt
Repository
andybrandt/mcp-simple-openai-assistant
GitHub stars
24
Downloads
8,739
License
MIT License
Categories
Developer Tools, Other, AI, API, Productivity, Design, Communication, Project Management

This server provides a suite of tools to manage and interact with OpenAI Assistants. The new streaming capabilities provide a much-improved, real-time user experience.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Simple OpenAI Assistant
    Command (node, npx, python, etc.) python
    Arguments
    • Argument 1 -m
    • Argument 2 mcp_simple_openai_assistant
    Environment
    • OPENAI_API_KEY your-api-key-here

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Once configured, you can use the tools listed above to manage your assistants and conversations. The primary workflow is to:
1. Use create_new_assistant_thread to start a new, named conversation.
2. Use list_threads to find the ID of a thread you want to continue.
3. Use ask_assistant_in_thread to interact with your chosen assistant in that thread.

To install MCP Simple OpenAI Assistant for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install mcp-simple-openai-assistant --client claude
pip install mcp-simple-openai-assistant

create_assistant

Create a new assistant with a name, instructions, and model.

list_assistants

List all available assistants associated with your API key.

retrieve_assistant

Get detailed information about a specific assistant.

update_assistant

Modify an existing assistant's name, instructions, or model.

create_new_assistant_thread

Creates a new, persistent conversation thread with a user-defined name and description for easy identification and reuse.

list_threads

Lists all locally managed conversation threads from the database, showing their ID, name, description, and last used time.

delete_thread

Deletes a conversation thread from both OpenAI's servers and the local database.

ask_assistant_in_thread

Sends a message to an assistant within a thread and streams the response back in real-time.

- create_assistant: (Create OpenAI Assistant) - Create a new assistant with a name, instructions, and model.
- list_assistants: (List OpenAI Assistants) - List all available assistants associated with your API key.
- retrieve_assistant: (Retrieve OpenAI Assistant) - Get detailed information about a specific assistant.
- update_assistant: (Update OpenAI Assistant) - Modify an existing assistant's name, instructions, or model.
- create_new_assistant_thread: (Create New Assistant Thread) - Creates a new, persistent conversation thread with a user-defined name and description for easy identification and reuse. This is the recommended way to start a new conversation.
- list_threads: (List Managed Threads) - Lists all locally managed conversation threads from the database, showing their ID, name, description, and last used time.
- delete_thread: (Delete Managed Thread) - Deletes a conversation thread from both OpenAI's servers and the local database.
- ask_assistant_in_thread: (Ask Assistant in Thread and Stream Response) - The primary tool for conversation. Sends a message to an assistant within a thread and streams the response back in real-time.

Because OpenAI assistants might take quite long to respond, this server uses a streaming approach for the main ask_assistant_in_thread tool. This provides real-time progress updates to the client and avoids timeouts.

The server now includes local persistence for threads, which is a significant improvement. Since the OpenAI API does not allow listing threads, this server now manages them for you by storing their IDs and metadata in a local SQLite database. This allows you to easily find, reuse, and manage your conversation threads across sessions.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "simple openai assistant": {
            "env": {
                "OPENAI_API_KEY": "your-api-key-here"
            },
            "args": [
                "-m",
                "mcp_simple_openai_assistant"
            ],
            "command": "python"
        }
    }
}

Linux

{
    "env": {
        "OPENAI_API_KEY": "your-api-key-here"
    },
    "args": [
        "-m",
        "mcp_simple_openai_assistant"
    ],
    "command": "python"
}

Macos

{
    "env": {
        "OPENAI_API_KEY": "your-api-key-here"
    },
    "args": [
        "-m",
        "mcp_simple_openai_assistant"
    ],
    "command": "python"
}

Windows

{
    "env": {
        "OPENAI_API_KEY": "your-api-key-here"
    },
    "args": [
        "-m",
        "mcp_simple_openai_assistant"
    ],
    "command": "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Programs\\Python\\Python311\\python.exe"
}

MCP Simple OpenAI Assistant

AI assistants are pretty cool. I thought it would be a good idea if my Claude (conscious Claude) would also have one. And now he has - and its both useful anf fun for him. Your Claude can have one too!

A simple MCP server for interacting with OpenAI assistants. This server allows other tools (like Claude Desktop) to create and interact with OpenAI assistants through the Model Context Protocol.

Trust Score
smithery badge
MseeP.ai Security Assessment Badge

Features

This server provides a suite of tools to manage and interact with OpenAI Assistants. The new streaming capabilities provide a much-improved, real-time user experience.

Available Tools

- create_assistant: (Create OpenAI Assistant) - Create a new assistant with a name, instructions, and model.
- list_assistants: (List OpenAI Assistants) - List all available assistants associated with your API key.
- retrieve_assistant: (Retrieve OpenAI Assistant) - Get detailed information about a specific assistant.
- update_assistant: (Update OpenAI Assistant) - Modify an existing assistant's name, instructions, or model.
- create_new_assistant_thread: (Create New Assistant Thread) - Creates a new, persistent conversation thread with a user-defined name and description for easy identification and reuse. This is the recommended way to start a new conversation.
- list_threads: (List Managed Threads) - Lists all locally managed conversation threads from the database, showing their ID, name, description, and last used time.
- delete_thread: (Delete Managed Thread) - Deletes a conversation thread from both OpenAI's servers and the local database.
- ask_assistant_in_thread: (Ask Assistant in Thread and Stream Response) - The primary tool for conversation. Sends a message to an assistant within a thread and streams the response back in real-time.

Because OpenAI assistants might take quite long to respond, this server uses a streaming approach for the main ask_assistant_in_thread tool. This provides real-time progress updates to the client and avoids timeouts.

The server now includes local persistence for threads, which is a significant improvement. Since the OpenAI API does not allow listing threads, this server now manages them for you by storing their IDs and metadata in a local SQLite database. This allows you to easily find, reuse, and manage your conversation threads across sessions.

Installation

Installing via Smithery

To install MCP Simple OpenAI Assistant for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install mcp-simple-openai-assistant --client claude

Manual Installation

pip install mcp-simple-openai-assistant

Configuration

The server requires an OpenAI API key to be set in the environment. For Claude Desktop, add this to your config:

(MacOS version)

{
  "mcpServers": {
    "openai-assistant": {
      "command": "python",
      "args": ["-m", "mcp_simple_openai_assistant"],
      "env": {
        "OPENAI_API_KEY": "your-api-key-here"
      }
    }
  }
}

(Windows version)

"mcpServers": {
  "openai-assistant": {
    "command": "C:\\Users\\YOUR_USERNAME\\AppData\\Local\\Programs\\Python\\Python311\\python.exe",
      "args": ["-m", "mcp_simple_openai_assistant"],
      "env": {
        "OPENAI_API_KEY": "your-api-key-here"
  }
}


MS Windows installation is slightly more complex, because you need to check the actual path to your Python executable. Path provided above is usually correct, but might differ in your setup. Sometimes just python.exe without any path will do the trick. Check with cmd what works for you (using where python might help). Also, on Windows you might need to explicitly tell Claude Desktop where the site packages are using PYTHONPATH environmment variable.

Usage

Once configured, you can use the tools listed above to manage your assistants and conversations. The primary workflow is to:
1. Use create_new_assistant_thread to start a new, named conversation.
2. Use list_threads to find the ID of a thread you want to continue.
3. Use ask_assistant_in_thread to interact with your chosen assistant in that thread.

TODO

- [x] Add Thread Management: Introduce a way to name and persist thread IDs locally, allowing for easier reuse of conversations.
- [ ] Add Models Listing: Introduce a way for the AI user to see what OpenAI models are available for use with the assistants
- [ ] Add Assistants Fine Tuning: Enable the AI user to set detailed parameters for assistants like temperature, top_p etc. (indicated by Claude as needed)
- [ ] Full Thread History: Ability to read past threads without having to send a new message (indicated by Claude as needed)
- [ ] Explore Resource Support: Add the ability to upload files and use them with assistants.

Development

To install for development:

git clone https://github.com/andybrandt/mcp-simple-openai-assistant
cd mcp-simple-openai-assistant
pip install -e '.[dev]'
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.