tuui

🚀 Getting Started

You can quickly get started with the project through a variety of options tailored to your role and needs:

• To explore the project, visit the wiki page: TUUI.com

• To download and use the application directly, go to the releases page: Releases

• For developer setup, refer to the installation guide: Getting Started (English) | 快速入门 (中文)

• To ask the AI directly about the project, visit: TUUI@DeepWiki

⚙️ Core Requirements

To use MCP-related features, ensure the following preconditions are met for your environment:

• Set up an LLM backend (e.g., ChatGPT, Claude, Qwen or self-hosted) that supports tool/function calling.

• For NPX/NODE-based servers: Install Node.js to execute JavaScript/TypeScript tools.

• For UV/UVX-based servers: Install Python and the UV library.

• For Docker-based servers: Install DockerHub.

• For macOS/Linux systems: Modify the default MCP configuration (e.g., adjust CLI paths or permissions).

  Refer to the MCP Server Issue documentation for guidance

For guidance on configuring the LLM, refer to the template(i.e.: Qwen):

{
  "name": "Qwen",
  "apiKey": "",
  "url": "https://dashscope.aliyuncs.com/compatible-mode",
  "path": "/v1/chat/completions",
  "model": "qwen-turbo",
  "modelList": ["qwen-turbo", "qwen-plus", "qwen-max"],
  "maxTokensValue": "",
  "mcp": true
}

The configuration accepts either a JSON object (for a single chatbot) or a JSON array (for multiple chatbots):

[
  {
    "name": "Openrouter && Proxy",
    "apiKey": "",
    "url": "https://api3.aiql.com",
    "urlList": ["https://api3.aiql.com", "https://openrouter.ai/api"],
    "path": "/v1/chat/completions",
    "model": "openai/gpt-4.1-mini",
    "modelList": [
      "openai/gpt-4.1-mini",
      "openai/gpt-4.1",
      "anthropic/claude-sonnet-4",
      "google/gemini-2.5-pro-preview"
    ],
    "maxTokensValue": "",
    "mcp": true
  },
  {
    "name": "DeepInfra",
    "apiKey": "",
    "url": "https://api.deepinfra.com",
    "path": "/v1/openai/chat/completions",
    "model": "Qwen/Qwen3-32B",
    "modelList": [
      "Qwen/Qwen3-32B",
      "Qwen/Qwen3-235B-A22B",
      "meta-llama/Meta-Llama-3.1-70B-Instruct"
    ],
    "mcp": true
  }
]