Slite MCP Server 使用说明

项目简介

Slite MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,它允许 AI 助手 (如 Claude) 与 Slite 知识库进行交互。通过该服务器,AI 助手可以搜索、创建、更新 Slite Notes,并获取 Slite Ask 相关信息,从而扩展 AI 助手的能力,使其能够利用 Slite 中的知识和信息。

主要功能点

  • 资源访问: 提供 'slite://notes' 资源,允许 AI 助手获取 Slite Notes 信息。例如,可以列出所有笔记或根据 ID 获取特定笔记的内容。
  • 工具调用: 提供以下工具,支持 AI 助手执行更复杂的操作:
    • 'search-notes': 在 Slite 中搜索笔记,允许 AI 助手根据关键词查找相关信息。
    • 'create-note': 在 Slite 中创建新的笔记,允许 AI 助手记录新的想法或信息。
    • 'update-note': 更新 Slite 中已有的笔记,允许 AI 助手修改和完善现有内容。
    • 'get-ask-info': 获取 Slite Ask 的相关信息。
    • 'get-ask-index': 获取 Slite Ask 索引信息。
    • 'get-automation-assistant': 获取自动化助手的相关信息。

安装步骤

  1. 克隆仓库: 在你的本地计算机上克隆 GitHub 仓库:
    git clone https://github.com/ronaldtebrake/slite-mcp.git
  2. 进入项目目录: 使用 'cd' 命令进入克隆下来的项目目录:
    cd slite-mcp
  3. 安装依赖: 运行 'npm install' 命令安装项目所需的依赖包:
    npm install
  4. 配置 API 密钥: 在项目根目录下创建 '.env' 文件,并添加你的 Slite API 密钥:
    SLITE_API_KEY=你的_Slite_API_密钥
    请将 '你的_Slite_API_密钥' 替换为你在 Slite 开发者平台获取的 API 密钥。
  5. 构建项目: 运行 'npm run build' 命令编译 TypeScript 代码:
    npm run build
  6. 启动服务器: 运行 'npm run start' 命令启动 MCP 服务器:
    npm run start

服务器配置

要将此 MCP 服务器连接到 MCP 客户端(例如 Claude),你需要配置客户端的 MCP 设置。以下是一个配置示例,你需要根据你的实际环境进行调整。

{
  "mcpServers": {
    "slite": {
      "command": "node",  // 启动服务器的命令,这里使用 Node.js
      "args": ["/path/to/slite-mcp-server/dist/index.js"], // 启动服务器的参数,指向编译后的 index.js 文件路径。请替换为实际路径,例如:"/Users/your_username/slite-mcp/dist/index.js"
      "env": {
        "SLITE_API_KEY": "你的_Slite_API_密钥" //  Slite API 密钥,这里的值会被 .env 文件中的 SLITE_API_KEY 覆盖,但此处也需要配置,方便客户端识别。请替换为你的 Slite API 密钥
      }
    }
  }
}

配置说明:

  • 'server name': 'slite' (服务器名称,你可以自定义,用于在 MCP 客户端中标识此服务器连接)
  • 'command': 'node' (启动服务器的命令,通常为 Node.js 解释器)
  • 'args': '["/path/to/slite-mcp-server/dist/index.js"]' (启动服务器的参数,请务必将 '/path/to/slite-mcp-server/dist/index.js' 替换为 'slite-mcp-server/dist/index.js' 文件在你电脑上的实际绝对路径。例如,如果你的项目放在用户目录下的 'documents/slite-mcp' 文件夹中,并且你的用户名是 'user',则路径可能类似于 '/Users/user/documents/slite-mcp/dist/index.js')
  • 'env': '{ "SLITE_API_KEY": "你的_Slite_API_密钥" }' (环境变量配置,用于传递 Slite API 密钥给服务器。请将 '你的_Slite_API_密钥' 替换为你的 Slite API 密钥。 注意,虽然这里配置了API密钥,但服务器启动时会优先从 '.env' 文件中读取 'SLITE_API_KEY' 环境变量。)

如何找到 'index.js' 的绝对路径:

  1. 打开终端或命令提示符。
  2. 使用 'cd' 命令进入你的 'slite-mcp' 项目目录。
  3. 运行 'pwd' 命令 (Linux/macOS) 或 'cd' (Windows) 命令,这将显示当前目录的绝对路径。
  4. 手动将显示的路径拼接上 '/dist/index.js' 即可得到 'index.js' 文件的绝对路径。

基本使用方法

配置完成后,在支持 MCP 协议的 AI 助手 (如 Claude) 中,你就可以使用以下方式与 Slite 知识库进行交互:

  • 资源 URI: 使用 'slite://notes' 可以访问 Slite Notes 资源。例如,在 Claude 中,你可以询问 "Read resource slite://notes"。
  • 工具调用: 使用工具名称调用相应的 Slite 功能。例如,要搜索笔记,你可以指示 Claude 调用 'search-notes' 工具并提供搜索关键词。

具体的使用方式取决于你所使用的 MCP 客户端 (如 Claude) 的界面和指令格式。请参考你使用的 MCP 客户端的文档来了解如何利用配置的 MCP 服务器。

信息

分类

生产力应用