Squad MCP 服务器

一个模型上下文协议 (MCP) 服务器，将小队——由 AI 驱动的产品发现和策略平台——连接到任何 MCP 感知的大语言模型 (LLM) 应用程序。它提供了一个丰富的工具包，可以直接从您喜爱的 AI 辅助工具中创建、查询和更新产品策略工件（机会、解决方案、结果、需求、知识、工作区和反馈）。

此仓库还包含 @squadai/tools NPM 包的源代码，该包提供了与 Squad API 交互的客户端工具。

为什么？

通过 Squad MCP 服务器，您可以在一个对话流程中研究、构思和规划产品，而无需离开您的编辑器或聊天窗口。

✨ 工具

每个工具都符合 MCP JSON 模式格式，因此代理可以自动内省输入和输出。

🚀 快速开始

1 · 获取 Squad API 密钥

1. 在 https://meetsquad.ai 注册/登录。
2. 打开 设置 → 开发者 → API 密钥。
3. 创建密钥并复制其值。

2 · 运行服务器

选择适合您环境的安装方法。

选项 A – 独立可执行文件 (推荐用于本地使用)

从项目的 GitHub 发布 页面下载适用于您操作系统的最新二进制文件，并直接运行：

bash

Windows

squad-mcp.exe

macOS / Linux — 首先使文件可执行

chmod +x squad-mcp
./squad-mcp

以通常的方式传递环境变量：

bash
SQUAD_API_KEY= SQUAD_ENV=production ./squad-mcp

选项 B – Docker (推荐用于生产环境)

bash

构建镜像 (一次)

docker build -t mcp/meet-squad -f Dockerfile .

在标准输入输出上运行服务器

docker run --rm -i
-e SQUAD_API_KEY=
mcp/meet-squad

选项 C – 从源代码

bash
git clone https://github.com/the-basilisk-ai/squad-mcp.git
cd squad-mcp
npm install
npm run build # 转译到 ./dist
node dist/index.js

📦 NPM 包 (@squadai/tools)

此仓库还包括一个 NPM 包 @squadai/tools，该包提供了一组函数，可以从您自己的 Node.js 应用程序或脚本中以编程方式与 Squad API 交互。

要安装该包：

bash
npm install @squadai/tools

或

yarn add @squadai/tools

或

pnpm add @squadai/tools

然后可以在您的代码中导入和使用这些工具。您仍然需要 Squad API 密钥或 JWT 进行身份验证（参见上面的快速开始部分）。

示例用法 (Vercel AI)：

typescript
import { generateText, tool } from 'ai';
import { tools as squadTools } from "@squadai/tools"

const result = await generateText({
model: yourModel,
tools: squadTools({
jwt: "JWT",
orgId: "orgId",
workspaceId: "workspaceId"
}),
prompt: "What is the weather in San Francisco?",
});

⚙️ 与 MCP 客户端集成
--------------------------------在您的客户端配置文件（例如 claude_desktop_config.json 或 Cursor）中添加一个 mcpServers 条目。根据安装方法调整 command。

使用独立可执行文件

jsonc
{
"mcpServers": {
"meet-squad": {
"command": "C:/path/to/squad-mcp.exe",
"env": {
"SQUAD_API_KEY": "YOUR_API_KEY_HERE",
}
}
}
}

使用 Docker

jsonc
{
"mcpServers": {
"meet-squad": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "SQUAD_API_KEY",
"mcp/meet-squad"
],
"env": {
"SQUAD_API_KEY": "YOUR_API_KEY_HERE",
}
}
}
}

如果您通过 NPX 安装，请使用 "command": "npx"。

重启客户端后，您应该能看到 Squad 工具（锤子 🔨 图标）列出并准备好使用。

🛠️ 环境变量

🧑‍💻 开发

bash
npm install
npm run format
npm run openapi:squad # 根据 openapi/squad.json 重新生成类型化的客户端
npm run build
node dist/index.js

测试套件仍在开发中；欢迎贡献。