Textwell MCP服务器使用说明

项目简介

Textwell MCP服务器是一个专为 macOS 上的 Textwell 应用程序设计的 MCP (Model Context Protocol) 服务器。它允许用户通过 MCP 协议，以编程方式向 Textwell 应用写入文本内容。该服务器提供了一个 'write-text' 工具，支持文本替换、插入和追加三种写入模式，方便用户在各种自动化场景中集成 Textwell 的文本编辑功能。

主要功能点

文本写入工具 ('write-text'): 提供向 Textwell 应用写入文本的核心功能。
- 替换模式 (replace): 将 Textwell 当前内容替换为新文本。适用于需要完全覆盖原有内容的场景。
- 插入模式 (insert): 在 Textwell 当前光标位置插入文本。适用于在已有文本中添加内容。
- 追加模式 (add): 将文本追加到 Textwell 当前内容的末尾。适用于在保留原有内容的基础上添加新内容。
基于 MCP 协议: 遵循 MCP 协议标准，易于与任何支持 MCP 协议的客户端集成。
macOS 平台专用: 利用 Textwell 的 URL Scheme 实现文本写入，专为 macOS 系统设计。

安装步骤

克隆仓库 打开终端，执行以下命令克隆 Textwell MCP 服务器仓库到本地：

git clone https://github.com/worldnine/textwell-mcp
cd textwell-mcp

安装依赖 在项目根目录下，执行 npm 命令安装项目依赖：
```
npm install
```
构建服务器 执行以下命令构建服务器代码：
```
npm run build
```
构建完成后，会在项目根目录下生成 'dist' 目录，服务器程序 'server.js' 位于 'dist' 目录中。

服务器配置

MCP 客户端需要配置以下信息才能连接到 Textwell MCP 服务器。以下是 JSON 格式的配置信息示例，请根据实际情况进行配置：

{
  "serverName": "textwell-mcp",  // 服务器名称，可自定义
  "command": "node",             // 启动服务器的命令，这里使用 Node.js 运行时
  "args": [                       // 启动命令的参数
    "dist/server.js"            // 服务器程序入口文件路径，相对于项目根目录
  ],
  "cwd": "/path/to/textwell-mcp"   // 可选，MCP服务器的工作目录，如果 MCP 客户端启动服务器失败，请尝试配置为 Textwell MCP 服务器的项目根目录的绝对路径
}

配置信息说明:

'serverName': MCP 服务器的名称，客户端用于标识和管理连接。可以自定义设置。
'command': 启动 MCP 服务器的可执行命令。由于 Textwell MCP 服务器是 Node.js 应用，这里设置为 'node'。
'args': 传递给启动命令的参数列表。这里指定了服务器程序的入口文件 'dist/server.js'。请确保此路径相对于您配置的工作目录或项目根目录是正确的。
'cwd': (可选) MCP 服务器的工作目录。如果 MCP 客户端在启动服务器时遇到问题，可以尝试设置此项为 Textwell MCP 服务器的项目根目录的绝对路径。例如：'/Users/yourusername/textwell-mcp'。请替换 '/Users/yourusername/textwell-mcp' 为您实际的项目存放路径。

注意:

请确保您的 macOS 系统上已安装 Node.js 环境。
MCP 客户端需要能够执行 'node' 命令，并将工作目录切换到 Textwell MCP 服务器的项目根目录或指定 'cwd'。

基本使用方法

启动服务器: 通过 MCP 客户端配置并启动 Textwell MCP 服务器。
客户端发送请求: 使用 MCP 客户端向 Textwell MCP 服务器发送请求，调用 'write-text' 工具，并根据需要选择 'mode' (replace, insert, add) 和提供 'text' 参数。
Textwell 执行文本操作: 服务器接收到请求后，会通过 URL Scheme 调用 Textwell 应用，执行相应的文本写入操作。
客户端接收响应: 服务器执行成功后，会向 MCP 客户端返回包含操作结果的响应。

示例 (MCP 客户端请求 - 假设使用 JSON-RPC 格式):

调用 'write-text' 工具，使用替换模式写入 "Hello Textwell!"：

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "write-text",
    "arguments": {
      "text": "Hello Textwell!",
      "mode": "replace"
    }
  },
  "id": 1
}

服务器响应示例 (成功):

{
  "jsonrpc": "2.0",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "Text replace completed"
      }
    ]
  },
  "id": 1
}

请参考 MCP 客户端的文档，了解如何配置和使用 MCP 服务器，并发送符合 MCP 协议的请求。

关键词