slabby (Russwyte)

🧱 板状的

](https://badge.fury.io/js/@russwyte%2Fslabby)  

用于Slab知识库与AI编码代理集成的MCP服务器

Slabby是一个 模型上下文协议 服务器，使Claude Code、Cline等AI编码代理能够直接读取和更新您的Slab文档。非常适合使RFC、技术文档和团队wiki与您的开发工作流程保持同步。

特性

• 📖 阅读Slab帖子 -按ID或URL获取帖子内容
• ✏️ 更新Slab帖子 -编辑带有归因于您的更改的帖子
• 🔍 搜索板 -在您的工作空间中查找帖子
• 📋 列出帖子 -按主题或标签浏览帖子
• 🔐 安全认证 -使用您的个人Slab API代币

安装

为了发展

git clone https://github.com/russwyte/slabby.git
cd slabby
bun install

来自npm

npm install -g @russwyte/slabby
# or
bun install -g @russwyte/slabby

配置

1.获取您的Slab API代币

1. 转到您的Slab工作区→ 设置 → API
2. 生成新的API令牌
3. 复制令牌（下一步需要它）

2.设置环境变量

创建一个 .env 项目根目录中的文件：

SLAB_API_TOKEN=your-api-token-here
SLAB_TEAM=your-team-domain  # e.g., "acme" for acme.slab.com

安全说明： 永远不要承诺你的 .env 文件到git。它已经在里面了 .gitignore.

3.配置克劳德代码

将Slabby添加到您的Claude Code MCP设置中：

macOS/Linux： ~/.config/claude-code/claude_desktop_config.json 窗户： %APPDATA%\claude-code\claude_desktop_config.json

{
  "mcpServers": {
    "slabby": {
      "command": "bun",
      "args": ["run", "/absolute/path/to/slabby/index.ts"],
      "env": {
        "SLAB_API_TOKEN": "your-token-here",
        "SLAB_TEAM": "your-team-domain"
      }
    }
  }
}

提示： 您还可以使用环境变量，而不是硬编码令牌：

{
  "mcpServers": {
    "slabby": {
      "command": "bun",
      "args": ["run", "/absolute/path/to/slabby/index.ts"],
      "env": {
        "SLAB_API_TOKEN": "${SLAB_API_TOKEN}",
        "SLAB_TEAM": "${SLAB_TEAM}"
      }
    }
  }
}

用法

配置后，Claude Code将自动访问这些工具：

slab__get_post

通过ID或URL获取Slab帖子：

Claude, read the Atlas RFC from https://myteam.slab.com/posts/atlas-rfc-xyz123

slab__update_post

更新板帖子：

Claude, update the Atlas RFC to reflect the single goal change

slab__search

在您的Slab工作区中搜索：

Claude, search Slab for all documents about "marketing automation"

slab__list_posts

列出主题中的帖子：

Claude, show me all RFCs in the Engineering topic

发展

在开发模式下运行（自动重新加载）：

bun run dev

在生产模式下运行：

bun run start

测试MCP服务器：

# Using the MCP inspector (install separately)
npx @modelcontextprotocol/inspector bun run index.ts

运作原理

Slabby实现了 模型上下文协议，允许像Claude这样的人工智能助手与外部工具和服务进行交互。当您要求Claude Code读取或更新Slab内容时，它：

1. 使用您的Slab API令牌进行身份验证（格式： Authorization: Bearer YOUR_TOKEN)
2. 在向Slab GraphQL API发出请求 https://api.slab.com/v1/graphql
3. 将Quill Delta内容转换为Markdown以提高可读性
4. 将结果返回给Claude Code

安全

• API令牌存储在本地 -从未发送到Anthropic的服务器
• Markdown输出 -Quill Delta内容自动转换为Markdown
• 默认情况下为只读 -更新操作需要明确的权限
• 基于环境的配置 -代币存储在 .env （忽略）

板坯API参考

该项目使用 板GraphQL APIGraphQL模式记录在： https://studio.apollographql.com/public/Slab/variant/current/schema/reference

关键操作：

• query GetPost -按ID获取帖子内容
• mutation UpdatePostContent -使用Quill Delta格式更新帖子内容
• query SearchPosts -跨工作区搜索帖子（基于光标的分页）
• query GetTopicPosts -列出特定主题的帖子
• query GetOrganizationPosts -列出组织中的所有职位

看 方案验证.md 有关详细的模式文档。

故障排除

“身份验证失败”错误

• 检查你的 SLAB_API_TOKEN 是正确的
• 验证令牌在Slab设置中是否具有适当的权限

“未找到团队”错误

• 确保 SLAB_TEAM 匹配您的Slab子域（例如，acme.slanb.com的“acme”）

Claude Code看不到工具

• 更新MCP配置后重新启动Claude代码
• 检查到的绝对路径 index.ts 是正确的
• 验证面包是否在您的路径中

贡献

欢迎投稿！请随时提交问题、分叉存储库和发送pull请求。

投稿时，请：

1. 为任何新功能添加测试
2. 确保所有测试通过 bun test
3. 遵循现有代码样式
4. 根据需要更新文档

许可证

版权所有2025 Russ White

根据Apache许可证2.0版（“许可证”）许可； 除非遵守许可证，否则您不得使用此项目。 您可以在以下网址获得许可证副本

http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则软件 根据许可证分发的内容按“原样”分发， 无任何明示或暗示的保证或条件。 请参阅许可证，了解管理权限和 许可证下的限制。

请参阅 许可证 完整许可证文本的文件。

相关项目

• 模型上下文协议 -MCP规范
• 克劳德代码 -人工智能驱动的开发环境
• 板坯API -官方Slab API文件

______________________________________________________________________