Squad MCP Server

一个模型上下文协议（MCP）服务器，用于连接_Squad_——一款由AI驱动的产品发现和策略平台——与任何支持MCP的大规模语言模型（LLM）应用。它提供了一个丰富的工具包，可以直接从您最喜欢的AI副驾创建、查询和更新产品策略工件（机会、解决方案、结果、需求、知识、工作空间和反馈）。

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

为什么？

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

✨ 工具

工具前缀	目的	典型操作
opportunity_*	发现并优化产品机会	创建、列出、更新
solution_*	生成并迭代解决方案	创建、列出、更新
outcome_*	跟踪期望的业务或用户结果	创建、列出
knowledge_*	存储有用的参考资料 / 研究	创建、列出
workspace_*	管理Squad工作空间	获取、更新
feedback_*	将客户或分析反馈发送到Squad	创建

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

🚀 快速开始

1 · 获取Squad API密钥

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

2 · 运行服务器

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

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

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

# Windows
squad-mcp.exe

# macOS / Linux — 首先使文件具有可执行权限
chmod +x squad-mcp
./squad-mcp

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

SQUAD_API_KEY=<您的密钥> SQUAD_ENV=production ./squad-mcp

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

# 构建镜像（一次）
docker build -t mcp/meet-squad -f Dockerfile .

# 在标准输入输出上运行服务器
docker run --rm -i \
  -e SQUAD_API_KEY=<您的密钥> \
  mcp/meet-squad

选项C – NPX (推荐简易设置)

# 直接使用npx运行（无需安装）
SQUAD_API_KEY=<您的密钥> npx @squadai/tools

# 或将API密钥作为命令参数传递
npx @squadai/tools --api-key <您的密钥>

选项D – 从源码

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

---

📦 NPM包 (@squadai/tools)

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

要安装该包：

npm install @squadai/tools
# 或
yarn add @squadai/tools
# 或
pnpm add @squadai/tools

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

示例用法（Vercel AI）：

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: "旧金山的天气如何？",
});

⚙️ 与MCP客户端集成

在客户端配置中添加一个_mcpServers_条目（例如claude_desktop_config.json或Cursor）。调整command以匹配安装方法。

使用单独可执行文件

{
  "mcpServers": {
    "@squadai/tools": {
      "command": "C:/path/to/squad-mcp.exe",
      "env": {
        "SQUAD_API_KEY": "您的API密钥",
      },
    },
  },
}

使用Docker

{
  "mcpServers": {
    "@squadai/tools": {
      "command": "docker",
      "args": ["run", "-i", "--rm", "-e", "SQUAD_API_KEY", "mcp/meet-squad"],
      "env": {
        "SQUAD_API_KEY": "您的API密钥",
      },
    },
  },
}

使用NPX

{
  "mcpServers": {
    "squad": {
      "command": "npx",
      "args": ["@squadai/tools"],
      "env": {
        "SQUAD_API_KEY": "您的API密钥",
      },
    },
  },
}

Claude Code集成

对于Claude Code，您可以使用以下命令添加Squad MCP服务器：

claude mcp add squad -e SQUAD_API_KEY=您的API密钥 -- npx @squadai/tools

这将在所有Claude Code会话中使Squad工具可用。

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

🛠️ 环境变量

变量	必需	默认值	描述
SQUAD_API_KEY	是	–	在Squad生成的个人访问令牌
SQUAD_ENV	否	production	覆盖Squad API基础URL（staging，development，…）

🧑‍💻 开发

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

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