内容
# MCP^2(MCPSQ)
[](https://github.com/xinbenlv/mcpsq/actions/workflows/ci.yml)
MCP^2(MCPSQ) 是一个简单的 MCP 服务器,用于发现和管理 MCP 服务器。有关更多信息,请访问我们的网站 [mcpsq.xyz](https://mcpsq.xyz)。
## 使用方法
```bash
npm start
```
## 本地开发
### 先决条件
- [Node.js](https://nodejs.org/) (v18 或更高版本)
- [Cursor](https://cursor.com/) 编辑器
### 安装
1. 克隆代码库:
```bash
git clone https://github.com/xinbenlv/mcpsq.git
cd mcpsq
```
2. 安装依赖:
```bash
npm install
```
### 运行服务器
在本地启动 MCP 服务器:
```bash
# 生产模式
npm start
# 开发模式,支持自动重载
npm run dev
# 将 TypeScript 构建为 JavaScript
npm run build
```
服务器将在 `http://localhost:3000` 启动,并提供:
- SSE 端点在 `GET /mcp`
- 消息处理在 `POST /messages`
### 配置 Cursor MCP 集成
要将此 MCP 服务器与 Cursor 一起使用,请将以下配置添加到您的 Cursor MCP 设置中:
#### 选项 1:全局配置
创建或编辑 `~/.cursor/mcp.json`:
```json
{
"mcpServers": {
"mcpsq": {
"url": "http://localhost:3000/mcp"
}
}
}
```
#### 选项 2:项目特定配置
在项目根目录创建 `.cursor/mcp.json`:
```json
{
"mcpServers": {
"mcpsq": {
"url": "http://localhost:3000/mcp"
}
}
}
```
### 可用的 MCP 工具
配置完成后,以下工具将在 Cursor 中可用:
- **`find-mcp-server`**:搜索与您的查询相关的 MCP 服务器
- **`add-mcp-server-to-cursor`**:将 MCP 服务器添加到您的 Cursor 配置中
- **`list-current-mcp-servers`**:列出所有当前配置的 MCP 服务器
- **`remove-mcp-server-from-cursor`**:从您的配置中移除 MCP 服务器
### 测试集成
1. 本地启动 MCPSQ 服务器
2. 使用上述 MCP 设置配置 Cursor
3. 重启 Cursor 或重新加载 MCP 配置
4. 在 Cursor 聊天中尝试询问:“查找数据库管理的 MCP 服务器”
5. MCPSQ 工具应出现在可用工具列表中
### 开发脚本
```bash
# 在生产模式下启动服务器
npm start
# 在开发模式下启动服务器,支持自动重载
npm run dev
# 将 TypeScript 构建为 JavaScript
npm run build
# 清理构建目录
npm run clean
# 验证数据文件
npm run validate:data
# 进行类型检查,不生成文件
npm run typecheck
```
### 开发工作流程
1. **开发**:使用 `npm run dev` 进行开发,文件更改时自动重启
2. **类型检查**:运行 `npm run typecheck` 检查 TypeScript 错误而不进行构建
3. **构建**:使用 `npm run build` 将 TypeScript 编译为 JavaScript(会自动先清理)
4. **生产**:使用 `npm start` 直接运行编译后的 TypeScript,使用 tsx
### 故障排除
- **服务器未启动**:检查端口 3000 是否可用
- **Cursor 无法连接**:验证 MCP 配置文件路径和 JSON 语法
- **工具未出现**:检查 Cursor 的 MCP 日志输出面板
- **TypeScript 错误**:运行 `npm run typecheck` 查看详细错误信息
## Heroku 部署
MCPSQ 可以轻松部署到 Heroku 进行云托管:
### 先决条件
- 安装 [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli)
- Heroku 账户
### 部署步骤
1. **登录 Heroku**:
```bash
heroku login
```
2. **创建一个新的 Heroku 应用**:
```bash
heroku create your-mcpsq-app-name
```
3. **部署到 Heroku**:
```bash
git push heroku main
```
4. **打开您的部署应用**:
```bash
heroku open
```
### 配置
该应用将自动:
- 使用 Heroku 的 `PORT` 环境变量
- 在部署期间通过 `heroku-postbuild` 脚本构建 TypeScript 代码
- 使用编译后的 JavaScript 启动服务器
您的 MCPSQ 服务器将可在以下地址访问:
- **MCP 端点**:`https://your-app-name.herokuapp.com/mcp`
### 与 Cursor 一起使用
配置 Cursor 使用您在 Heroku 部署的 MCPSQ 服务器:
```json
{
"mcpServers": {
"mcpsq": {
"url": "https://your-app-name.herokuapp.com/mcp"
}
}
}
```
## 数据
数据存储在 `data` 目录中。
## 贡献
欢迎贡献!请随时提交更新 [`data` 目录](data) 中数据的拉取请求。
## ROADMAP
- [x] 处理所需的环境变量
- [x] 发布到 npmjs.com
- [x] 添加 Heroku 部署支持
## 许可证
本项目根据 MIT 许可证进行许可 - 详细信息请参见 [LICENSE](LICENSE) 文件。