feat(desktop): embed BoosAPI Desktop client as a subproject

Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as a monorepo subdirectory under desktop/. Source only — node_modules, dist, Cargo target and the upstream .git history are excluded. desktop/ keeps its own independent Cargo workspace (desktop/src-tauri with crates/*); it is not part of the backend boosapi crate, so a `cargo check` at the metapi root still compiles only the backend. Build the desktop app from desktop/src-tauri per desktop/README.md. Note: app icons are still placeholder assets pending the final BoosAPI logo. The updater signing keys live outside the repo and are not included.
2026-06-22 11:32:57 +08:00
parent d9c78ecc73
commit e0a5f57793
2305 changed files with 449355 additions and 0 deletions
@@ -0,0 +1,205 @@
+# MCP Servers
+
+## What is MCP?
+
+The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is an open standard that lets AI models interact with external tools and data sources. BoosApi acts as an MCP client — you add MCP servers, and the AI can call the tools they expose during a conversation.
+
+---
+
+## Transport Protocols
+
+BoosApi supports three transport protocols for communicating with MCP servers:
+
+| Protocol | Connection | Use Case | Configuration |
+|----------|-----------|----------|---------------|
+| **Stdio** | Local process | Tools installed on your machine, launched via `npx`, `uvx`, `python`, etc. | `command` + `args` + optional `env` |
+| **SSE** | Remote server | Server-Sent Events endpoint hosted on a remote machine or cloud service | `url` |
+| **StreamableHTTP** | Remote server | HTTP streaming endpoint, the newer alternative to SSE | `url` |
+
+---
+
+## Adding MCP Servers
+
+### Form Creation
+
+1. Go to **Settings → MCP Servers**.
+2. Click **Add MCP Server**.
+3. Enter a name and select the transport protocol.
+4. Fill in the fields for your chosen protocol:
+   - **Stdio** — command to run, arguments (JSON array), environment variables (JSON object), timeout.
+   - **SSE** — endpoint URL, timeout.
+   - **StreamableHTTP** — endpoint URL, timeout.
+5. Click **Save**.
+
+### JSON Import
+
+Click **JSON Import** and paste a configuration object. BoosApi accepts the standard MCP JSON format:
+
+#### Stdio server
+
+```json
+{
+  "mcpServers": {
+    "fetch": {
+      "command": "uvx",
+      "args": ["mcp-server-fetch"]
+    }
+  }
+}
+```
+
+#### SSE server
+
+```json
+{
+  "mcpServers": {
+    "remote-tools": {
+      "type": "sse",
+      "url": "https://example.com/sse"
+    }
+  }
+}
+```
+
+#### StreamableHTTP server
+
+```json
+{
+  "mcpServers": {
+    "remote-http": {
+      "type": "streamablehttp",
+      "url": "https://example.com/mcp"
+    }
+  }
+}
+```
+
+#### Multiple servers at once
+
+```json
+{
+  "mcpServers": {
+    "fetch": {
+      "command": "uvx",
+      "args": ["mcp-server-fetch"]
+    },
+    "filesystem": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/me/projects"]
+    },
+    "remote": {
+      "type": "sse",
+      "url": "https://example.com/sse"
+    }
+  }
+}
+```
+
+---
+
+## Configuration Examples
+
+### Web Fetching — `mcp-server-fetch`
+
+Fetches web pages and converts them to readable text for the AI.
+
+```json
+{
+  "mcpServers": {
+    "fetch": {
+      "command": "uvx",
+      "args": ["mcp-server-fetch"]
+    }
+  }
+}
+```
+
+### File Operations — `@modelcontextprotocol/server-filesystem`
+
+Gives the AI read/write access to specific directories on your machine.
+
+```json
+{
+  "mcpServers": {
+    "filesystem": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@modelcontextprotocol/server-filesystem",
+        "/Users/me/documents",
+        "/Users/me/projects"
+      ]
+    }
+  }
+}
+```
+
+### Remote SSE Server
+
+Connect to a remote tool server over Server-Sent Events.
+
+```json
+{
+  "mcpServers": {
+    "cloud-tools": {
+      "type": "sse",
+      "url": "https://mcp.example.com/sse"
+    }
+  }
+}
+```
+
+### Stdio with Environment Variables
+
+Pass API keys or configuration to the server process via environment variables.
+
+```json
+{
+  "mcpServers": {
+    "weather": {
+      "command": "python",
+      "args": ["-m", "weather_server"],
+      "env": {
+        "WEATHER_API_KEY": "your-api-key"
+      }
+    }
+  }
+}
+```
+
+---
+
+## Built-in Tools
+
+BoosApi ships with built-in tools that are available without adding any external MCP server:
+
+| Tool | Description |
+|------|-------------|
+| **@boosapi/fetch** | Fetch web pages and HTTP resources |
+| **@boosapi/search-file** | Search for files on your local file system |
+
+Built-in tools are listed in the MCP Servers settings alongside your custom servers and can be enabled or disabled individually.
+
+---
+
+## Tool Execution Panel
+
+When the AI calls an MCP tool during a conversation, BoosApi displays a **tool execution panel** inline in the chat. The panel shows:
+
+- The **tool name** and the **server** it belongs to.
+- The **input arguments** sent to the tool.
+- The **output** returned by the tool.
+- Execution status (running, succeeded, or failed).
+
+Click on any tool call in the conversation to expand its details. This makes it easy to verify what the AI did and debug unexpected results.
+
+---
+
+## Tool Loop Limit
+
+In Settings -> Conversation, MCP Tool Loop Max Iterations limits how many consecutive tool-call rounds one model response may run. Lower values reduce latency and cost; higher values allow longer autonomous tool workflows.
+
+## Next Steps
+
+- [API Gateway](./gateway) — expose your providers as a local API server
+- [Getting Started](./getting-started) — return to the quick start guide