Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OPENAI_API_KEY | Yes | Your OpenAI API key |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| create_assistant | Create a new OpenAI assistant to talk to about your desired topic. You can provide instructions that this assistant will follow and specify which of OpenAI's models it will use. NOTE: It is recommended to check existing assistants with list_assistants before creating a new one. |
| create_new_assistant_thread | Creates a new, persistent conversation thread with a user-defined name and description for easy identification and reuse. These threads are stored in OpenAI's servers and are not deleted unless the user deletes them, which means you can re-use them for future conversations. Additionally, the thread name and description are stored in the local database, which means you can list them and update them later. Think how you can utilize threads in your particular use case. |
| list_threads | Lists all locally saved conversation threads from the database. Returns a list of threads with their ID, name, description, and last used time. The thread ID can be used in the ask_assistant_in_thread tool to specify this thread to be continued. |
| update_thread | Updates the name and/or description of a locally saved conversation thread. Both the local database and the OpenAI thread object will be updated. The thread ID can be retrieved from the list_threads tool. |
| delete_thread | Deletes a conversation thread from both OpenAI's servers and the local database. This action is irreversible. |
| ask_assistant_in_thread | Sends a message to an assistant within a specific thread and streams the response. This provides progress updates and the final message in a single call. Use this to continue a conversation with an assistant in a specific thread. The thread ID can be retrieved from the list_threads tool. The assistant ID can be retrieved from the list_assistants tool. Threads are not inherently linked to a particular assistant, so you can use this tool to talk to any assistant in any thread. |
| list_assistants | List all available OpenAI assistants associated with the API key configured by the user. Returns a list of assistants with their IDs, names, and configurations. This can be used to select an assistant to use in the ask_assistant_in_thread tool instead of creating a new one. |
| retrieve_assistant | Get detailed information about a specific assistant. The ID required can be retrieved from the list_assistants tool. |
| update_assistant | Modify an existing assistant's name, instructions, or model used. At least one optional parameter - what to change - must be provided, otherwise the tool will return an error. The ID required can be retrieved from the list_assistants tool. |