Skip to content

Commit 8572ee5

Browse files
committed
docs: update README and localization for clarity and functionality
- Revised language sections in README and Chinese documentation for improved readability. - Enhanced feature descriptions to better highlight cross-platform support and user-friendly setup. - Updated installation instructions to reflect the use of Bun instead of npm. - Added a Table of Contents for easier navigation in both English and Chinese documents. - Improved Sidebar component by integrating a mode toggle for better user experience. - Adjusted Tauri configuration to use Bun commands for development and build processes.
1 parent 8fad46f commit 8572ee5

File tree

6 files changed

+177
-108
lines changed

6 files changed

+177
-108
lines changed

.dockerignore

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Node/Bun dependencies
2+
node_modules
3+
.bun
4+
bun.lock.bak
5+
6+
# Tauri build output
7+
src-tauri/target
8+
src-tauri/.cargo
9+
10+
# Git and editor files
11+
.git
12+
.gitignore
13+
*.log
14+
*.swp
15+
*.swo
16+
*.tmp
17+
.DS_Store
18+
19+
# OS-specific files
20+
Thumbs.db
21+
22+
# Docker
23+
.dockerignore
24+
Dockerfile
25+
26+
# Build artifacts
27+
dist
28+
build
29+
out
30+
31+
# folder
32+
docs
33+
images
34+
scripts
35+
36+
# files
37+
CHANGELOG.md
38+
CONTRIBUTORS
39+
LICENSE
40+
README.md

Dockerfile

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
FROM nailyudha/tauri:latest
2+
3+
WORKDIR /home/nonroot
4+
5+
COPY ./package.json ./bun.lock ./
6+
# cache bun
7+
RUN mkdir -p /home/nonroot/.bun
8+
9+
ENV BUN_INSTALL_CACHE=/home/nonroot/.bun/install-cache
10+
ENV BUN_GLOBAL_CACHE_DIR=/home/nonroot/.bun/install-cache
11+
ENV XDG_CACHE_HOME=/home/nonroot/.bun/install-cache
12+
13+
RUN apt-get update && apt-get install -y --no-install-recommends xdg-utils
14+
RUN for i in 1 2 3; do bun i --frozen-lockfile && break || sleep 5; done
15+
16+
COPY . .
17+
# For building Linux (Support for AMD64 & ARM64)
18+
RUN bun tauri build

README.md

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</p>
44

55
<p align="center">
6-
📘 Available languages:
6+
📘
77
<strong>English</strong> |
88
<a href="./docs/README.zh-CN.md">简体中文</a> |
99
<a href="./docs/README.ja-JP.md">日本語</a>
@@ -22,9 +22,10 @@
2222

2323
# MCP Linker
2424

25-
> A simple yet powerful tool to manage **Model Context Protocol (MCP) servers** for clients like **Claude, Cursor, Windsurf**. With just two clicks—**Get** and **Add**—you can connect to a server. Supports macOS and Windows via a Tauri GUI.
25+
[![GitHub last commit](https://img.shields.io/github/last-commit/milisp/mcp-linker)](https://github.com/milisp/mcp-linker/commits)
26+
![build](https://github.com/milisp/mcp-linker/actions/workflows/tauri-ci-win.yml/badge.svg)
2627

27-
> Want a Linux version? Let us know on [GitHub Discussions](https://github.com/milisp/mcp-linker/discussions).
28+
> Add MCP servers to Claude Desktop, Cursor, and Windsurf in two clicks. Cross-platform. Tauri GUI. Server management included.
2829
2930
---
3031

@@ -63,7 +64,7 @@
6364
✅ No technical skills required — just click and go!
6465
✅ Open-source and community-driven
6566
✅ Favorites & Recently Used: Quickly access your go-to servers
66-
✅ Cross-platform: macOS and experimental Windows support
67+
✅ Cross-platform: macOS, Windows, Linux support
6768
✅ Multi-language: English, 中文, 日本語
6869
✅ Improved error handling and user-friendly setup
6970

@@ -80,22 +81,7 @@
8081
8182
## 🛠️ How It Works
8283

83-
When you click **"Add"**, MCP Linker directly modifies your MCP configuration file to include the selected server.
84-
85-
> ⚠️ Warning: This will overwrite existing MCP configuration for that client. Please back up your config file if needed.
86-
87-
## 📂 Configuration File Paths
88-
89-
**Claude Desktop**
90-
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
91-
- **Windows**: `~/AppData/Roaming/Claude/claude_desktop_config.json`
92-
93-
**Cursor**
94-
- **Global config**: `~/.cursor/mcp.json`
95-
- **Project config**: `.cursor/mcp.json`
96-
97-
**Windsurf**
98-
- `~/.codeium/windsurf/mcp_config.json`
84+
[Wiki](https://github.com/milisp/mcp-linker/wiki#-how-it-works)
9985

10086
## 🖼️ Screenshots
10187

@@ -116,8 +102,8 @@ When you click **"Add"**, MCP Linker directly modifies your MCP configuration fi
116102

117103
Before working on this project, ensure you have the following installed:
118104

119-
- Node.js
120-
- bun (or pnpm/yarn/npm)
105+
- Node.js >= 20
106+
- bun
121107
- Rust toolchain (stable) for Tauri
122108

123109
## 🔧 Installation Steps
@@ -131,25 +117,7 @@ bun tauri dev
131117

132118
## 🔍 Troubleshooting
133119

134-
If you encounter installation issues:
135-
136-
1. Remove dependency lock files:
137-
```bash
138-
rm package-lock.json
139-
rm -rf node_modules
140-
```
141-
142-
2. Clean npm cache and reinstall:
143-
```bash
144-
npm cache clean --force
145-
npm install
146-
```
147-
148-
3. If errors persist, try with legacy peer deps:
149-
```bash
150-
npm cache clean --force
151-
npm install --legacy-peer-deps
152-
```
120+
[Wiki](https://github.com/milisp/mcp-linker/wiki#-troubleshooting)
153121

154122
## 🤝 Contributing
155123

@@ -171,9 +139,6 @@ Check out the list of [official MCP servers](https://github.com/modelcontextprot
171139

172140
Have questions or suggestions? Join our [GitHub Discussions](https://github.com/milisp/mcp-linker/discussions).
173141

174-
## ⏱️ GitHub Last Commit
175-
176-
[![GitHub last commit](https://img.shields.io/github/last-commit/milisp/mcp-linker)](https://github.com/milisp/mcp-linker/commits)
177142

178143
## 🎉 Contributors
179144

docs/README.zh-CN.md

Lines changed: 98 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1+
12
<p align="center">
2-
<img src="../public/logo.png" alt="Project Logo" width="200" />
3+
<img src="../public/logo.png" alt="项目 Logo" width="200" />
34
</p>
45

56
<p align="center">
6-
📘 语言切换:
7-
<a href="../README.md">English</a> |
8-
<strong>简体中文</strong> |
7+
📘
8+
<a href="../README.md">English</a> |
9+
<strong>简体中文</strong> |
910
<a href="./README.ja-JP.md">日本語</a>
1011
</p>
1112

1213
<p align="center">
1314
<a href="https://github.com/milisp/mcp-linker/stargazers">
14-
如果你觉得这个项目对你有帮助,欢迎点个 star 支持一下
15+
如果你觉得这个项目有用,欢迎给一个 Star
1516
</a>
1617
<br/>
1718
<a href="https://github.com/milisp/mcp-linker">
@@ -22,87 +23,129 @@
2223

2324
# MCP Linker
2425

25-
>轻松将 **Model Context Protocol (MCP) 服务器** 添加到你的 MCP 客户端(例如 Claude Cursor windsurf...),只需两步操作:**获取****添加**。支持 macos win
26-
27-
## 🔧 环境要求
26+
[![GitHub last commit](https://img.shields.io/github/last-commit/milisp/mcp-linker)](https://github.com/milisp/mcp-linker/commits)
27+
![build](https://github.com/milisp/mcp-linker/actions/workflows/tauri-ci-win.yml/badge.svg)
2828

29-
在运行本项目之前,请确保已安装以下工具:
29+
> 轻松将 MCP 服务器添加到 Claude Desktop、Cursor 和 Windsurf。跨平台。Tauri 图形界面。内置服务器管理功能。
3030
31-
- Node.js
32-
- bun(或 pnpm)
33-
- Rust 工具链(稳定版),用于构建 Tauri 应用
31+
---
3432

35-
## 🔽 Download MCP Linker
33+
## 📋 目录
34+
35+
- [用户指南](#-用户指南)
36+
- [下载](#-下载-mcp-linker)
37+
- [功能](#-功能)
38+
- [快速开始](#-快速开始)
39+
- [工作原理](#-工作原理)
40+
- [配置文件路径](#-配置文件路径)
41+
- [截图](#-截图)
42+
- [开发者指南](#-开发者指南)
43+
- [系统要求](#-系统要求)
44+
- [安装步骤](#-安装步骤)
45+
- [故障排除](#-故障排除)
46+
- [参与贡献](#-参与贡献)
47+
- [资源](#-资源)
48+
- [官方服务器](#-官方服务器)
49+
- [反馈与支持](#-反馈与支持)
50+
- [贡献者](#-贡献者)
3651

37-
👉 [在 🐙Gumroad 下载](https://wei40680.gumroad.com/l/jdbuvc?wanted=true)
38-
👉 [在 GitHub 发布页下载](https://github.com/milisp/mcp-linker/releases)
52+
---
3953

40-
## ✨ 功能特色
54+
# 👤 用户指南
4155

42-
✅ 一键添加 MCP 服务器
43-
✅ 支持多个 MCP 服务器配置
44-
✅ 开源并由社区驱动
45-
✅ 收藏夹功能:可将服务器加入收藏,便于快速访问
46-
✅ 最近使用:自动保存并展示最近添加的服务器
47-
✅ 支持 Windows:现已支持 Windows 平台(实验性)
48-
✅ 更好的错误处理与安装指南
56+
## 🔽 下载 MCP Linker
4957

50-
🗨 [反馈或提问](https://github.com/milisp/mcp-linker/discussions)
58+
👉 [在 🐙Gumroad 上下载](https://wei40680.gumroad.com/l/jdbuvc?wanted=true)
59+
👉 [在 GitHub Releases 上下载](https://github.com/milisp/mcp-linker/releases)
5160

52-
## 安装
61+
## ✨ 功能亮点
5362

54-
```bash
55-
git clone https://github.com/milisp/mcp-linker
56-
cd mcp-linker
57-
bun install
58-
bun tauri dev
59-
# yarn install
60-
# yarn tauri dev
61-
# pnpm install
62-
# pnpm tauri dev
63-
```
63+
✅ 一键添加 MCP 服务器
64+
✅ 管理多个服务器配置(添加、删除、收藏)
65+
✅ 无需技术背景——只需点击即可开始
66+
✅ 开源且由社区驱动
67+
✅ 收藏 & 最近使用:快速访问常用服务器
68+
✅ 跨平台支持:macOS、Windows、Linux
69+
✅ 多语言支持:英文、中文、日文
70+
✅ 改进的错误处理和更友好的安装流程
6471

65-
> **注意:** 如遇安装问题,可尝试删除 `package-lock.json``node_modules` 目录,然后执行以下命令:
66-
> ```bash
67-
> npm install --legacy-peer-deps
68-
> ```
72+
> 🛠️ *即将推出:* 一键安装服务器、状态监控等功能!
6973
7074
## 🚀 快速开始
7175

72-
1. **浏览与选择**:从可用服务器列表中选择一个 MCP 服务器。
73-
2. **安装**:点击 **“获取”** 查看服务器配置。
74-
3. **激活**:点击 **“添加”** 将其集成到你的 MCP 客户端。
76+
1. **选择** 一个 MCP 服务器
77+
2. 点击 **获取配置**
78+
3. 点击 **添加** 将其集成到你的 MCP 客户端
79+
4. 在收藏或历史记录中管理服务器
7580

76-
> 💡 提示:收藏与最近使用的服务器会被保存在本地,方便下次使用!
81+
> 💡 收藏和最近使用的服务器将保存在本地,提升工作流效率。
7782
78-
## 🌐 官方服务器
83+
## 🛠️ 工作原理
7984

80-
查看 [官方 MCP 服务器列表](https://github.com/modelcontextprotocol/servers)。
85+
[Wiki](https://github.com/milisp/mcp-linker/wiki#-how-it-works)
8186

82-
## 🖼️ 截图演示
87+
## 🖼️ 截图
8388

8489
### 服务器发现
85-
![发现截图](../images/home.png)
90+
![Discover Screenshot](../images/home.png)
8691

8792
### 配置示例
88-
![配置截图](../images/config.png)
93+
![Config Screenshot](../images/config.png)
8994

9095
### 管理示例
91-
![管理截图](../images/manager.png)
96+
![Manage Screenshot](../images/manager.png)
97+
98+
---
99+
100+
# 👨‍💻 开发者指南
101+
102+
## 💻 系统要求
103+
104+
在开发此项目之前,请确保已安装以下工具:
105+
106+
- Node.js >= 20
107+
- bun
108+
- Rust 工具链(稳定版)用于 Tauri
109+
110+
## 🔧 安装步骤
111+
112+
```bash
113+
git clone https://github.com/milisp/mcp-linker
114+
cd mcp-linker
115+
bun install
116+
bun tauri dev
117+
```
118+
119+
## 🔍 故障排除
120+
121+
[Wiki](https://github.com/milisp/mcp-linker/wiki#-troubleshooting)
92122

93123
## 🤝 参与贡献
94124

95-
欢迎任何形式的贡献!添加你自己的 MCP 服务器只需:
125+
我们欢迎社区贡献:
126+
127+
1. **Fork & Clone** 此仓库
128+
2. 为你的功能或修复 **创建分支**
129+
3. **提交 Pull Request**
130+
131+
---
132+
133+
# 📚 资源
134+
135+
## 🌐 官方服务器
136+
137+
请查看 [官方 MCP 服务器列表](https://github.com/modelcontextprotocol/servers?from=mcp-linker)
138+
139+
## 💬 反馈与支持
96140

97-
1. **Fork 并克隆** 此仓库。
98-
2. **提交 Pull Request** 提交你的更改。
141+
有问题或建议?欢迎加入我们的 [GitHub Discussions](https://github.com/milisp/mcp-linker/discussions)
99142

100143
## 🎉 贡献者
101144

102-
感谢以下贡献者对本项目的改进
145+
感谢以下贡献者改善本项目
103146

104-
- [@eltociear](https://github.com/eltociear) — 日文翻译
105-
- [@devilcoder01](https://github.com/devilcoder01) — 改进了 Windows 兼容性与项目安装说明
147+
- [@eltociear](https://github.com/eltociear)日语翻译
148+
- [@devilcoder01](https://github.com/devilcoder01)改进 Windows 构建兼容性、项目安装说明、GitHub Workflow、UI 与设计
106149

107150
---
108151

src-tauri/tauri.conf.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
"version": "1.2.2",
55
"identifier": "com.milisp.mcplinker",
66
"build": {
7-
"beforeDevCommand": "npm run dev",
7+
"beforeDevCommand": "bun run dev",
88
"devUrl": "http://localhost:1420",
9-
"beforeBuildCommand": "npm run build",
9+
"beforeBuildCommand": "bun run build",
1010
"frontendDist": "../dist"
1111
},
1212
"app": {
1313
"windows": [
1414
{
1515
"title": "MCP Linker",
1616
"width": 1064,
17-
"height": 720,
17+
"height": 768,
1818
"minWidth": 800,
1919
"minHeight": 600
2020
}

0 commit comments

Comments
 (0)