You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,24 +4,24 @@
4
4
5
5
#### TUUI is a desktop MCP client designed as a tool unitary utility integration, accelerating AI adoption through the Model Context Protocol (MCP) and enabling cross-vendor LLM API orchestration.
6
6
7
-
## :bulb: Introduction
7
+
## 📜 Introduction
8
8
9
9
This repository is essentially an **LLM chat desktop application based on MCP**. It also represents a bold experiment in **creating a complete project using AI**. Many components within the project have been directly converted or generated from the prototype project through AI.
10
10
11
11
Given the considerations regarding the quality and safety of AI-generated content, this project employs strict syntax checks and naming conventions. Therefore, for any further development, please ensure that you use the linting tools I've set up to check and automatically fix syntax issues.
12
12
13
-
## :sparkles: Features
13
+
## ✨ Features
14
14
15
-
-:sparkles: Accelerate AI tool integration via MCP
16
-
-:sparkles: Orchestrate cross-vendor LLM APIs through dynamic configuring
17
-
-:sparkles: Automated application testing Support
18
-
-:sparkles: TypeScript support
19
-
-:sparkles: Multilingual support
20
-
-:sparkles: Basic layout manager
21
-
-:sparkles: Global state management through the Pinia store
22
-
-:sparkles: Quick support through the GitHub community and official documentation
15
+
-✨ Accelerate AI tool integration via MCP
16
+
-✨ Orchestrate cross-vendor LLM APIs through dynamic configuring
17
+
-✨ Automated application testing Support
18
+
-✨ TypeScript support
19
+
-✨ Multilingual support
20
+
-✨ Basic layout manager
21
+
-✨ Global state management through the Pinia store
22
+
-✨ Quick support through the GitHub community and official documentation
23
23
24
-
## :book: Getting Started
24
+
## 🚀 Getting Started
25
25
26
26
You can quickly get started with the project through a variety of options tailored to your role and needs:
27
27
@@ -33,7 +33,7 @@ You can quickly get started with the project through a variety of options tailor
33
33
34
34
- To `ask the AI` directly about the project, visit: [TUUI@DeepWiki](https://deepwiki.com/AI-QL/tuui)
35
35
36
-
## :wrench: Core Requirements
36
+
## ⚙️ Core Requirements
37
37
38
38
**To use MCP-related features, ensure the following preconditions are met for your environment:**
39
39
@@ -105,7 +105,7 @@ For the decomposable package, you can also modify the default configuration of t
105
105
106
106
Once you modify or import the LLM configuration, it will be stored in your localStorage by default. You can use the developer tools to view or clear the corresponding cache.
107
107
108
-
## Remote MCP server
108
+
## 🌐 Remote MCP server
109
109
110
110
You can utilize Cloudflare's recommended [mcp-remote](https://github.com/geelen/mcp-remote) to implement the full suite of remote MCP server functionalities (including Auth). For example, simply add the following to your [config.json](src/main/assets/config/config.json) file:
111
111
@@ -128,7 +128,7 @@ If you encounter any issues (please try to maintain OAuth auto-redirect to preve
128
128
129
129
<aid="mcp-server-issue"></a>
130
130
131
-
## MCP Server Issue
131
+
## 🚸 MCP Server Issue
132
132
133
133
When launching the MCP server, if you encounter spawn errors like `ENOENT`, try installing the corresponding MCP server locally and invoking it using an absolute path.
134
134
@@ -144,23 +144,23 @@ This is a known issue, and many cases remain unresolved. The MCP SDK includes a
144
144
145
145
The issue remains unresolved on other platforms, specifically `macOS`. Although several workarounds are available, this ticket consolidates the most effective ones and highlights the simplest method: [How to configure MCP on macOS](https://github.com/AI-QL/tuui/issues/2).
146
146
147
-
## :inbox_tray: Contributing
147
+
## 🤝 Contributing
148
148
149
149
We welcome contributions of any kind to this project, including feature enhancements, UI improvements, documentation updates, test case completions, and syntax corrections. I believe that a real developer can write better code than AI, so if you have concerns about certain parts of the code implementation, feel free to share your suggestions or submit a pull request.
150
150
151
151
Please review our [Code of Conduct](CODE_OF_CONDUCT.md). It is in effect at all times. We expect it to be honored by everyone who contributes to this project.
152
152
153
153
For more information, please see [Contributing Guidelines](CONTRIBUTING.md)
154
154
155
-
## :beetle: Opening an Issue
155
+
## 🙋 Opening an Issue
156
156
157
157
Before creating an issue, check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.
158
158
159
-
### :lock: Reporting Security Issues
159
+
### 🔒️ Reporting Security Issues
160
160
161
161
Review our [Security Policy](SECURITY.md). Do not file a public issue for security vulnerabilities.
162
162
163
-
## :lipstick: Demo
163
+
## 🎉 Demo
164
164
165
165
### MCP primitive visualization
166
166
@@ -190,7 +190,7 @@ Review our [Security Policy](SECURITY.md). Do not file a public issue for securi
0 commit comments