使用说明

项目简介

TSAP MCP Server (Text Search and Processing Model Context Protocol Server) 是一个实现了 Model Context Protocol 的服务器，旨在为大型语言模型（LLM）提供强大的文本处理能力。它通过标准化的 MCP 接口，集成了 ripgrep, awk, jq, sqlite 等优秀的命令行工具，使 LLM 能够执行复杂的文本搜索、转换、分析等操作，而无需用户深入了解这些工具的复杂语法。TSAP 旨在提升 LLM 在处理各种领域文本数据时的效率和能力。

主要功能点

强大的文本搜索能力: 基于 'ripgrep' 提供高性能的正则表达式搜索。
灵活的文本转换和处理: 基于 'awk' 和 'jq' 实现高级文本和 JSON 数据处理。
结构化数据查询: 基于 'sqlite' 支持对提取和转换后的数据进行关系型查询。
智能 HTML 和 PDF 处理: 内置 HTML 解析器和 PDF 文本提取器，能够处理复杂文档格式。
复合操作: 预置多种复合操作，如并行搜索、递归优化、上下文提取等，高效完成多步骤任务。
智能分析工具: 提供代码分析、文档探索、元数据提取等高级语义分析工具。
自进化和学习系统: 具备策略进化、模式分析等学习能力，不断优化搜索和分析策略。
插件架构: 支持插件扩展，方便集成第三方工具和领域特定功能。
多种性能模式: 提供快速、标准和深度等多种运行模式，平衡速度和分析深度。
任务模板: 预置代码安全审计、法规变更检测等常见任务模板，简化复杂工作流程。

安装步骤

克隆仓库:

git clone https://github.com/Dicklesworthstone/tsap_mcp_server.git
cd tsap_mcp_server

安装依赖:

bash scripts/install_dependencies.sh

这个脚本会自动安装 'ripgrep', 'jq', 'gawk', 和 'sqlite3'。

创建并激活虚拟环境:

uv venv --python=3.13 .venv
source .venv/bin/activate

安装 TSAP MCP Server:

uv pip install -e '.[dev,docs,performance,database,visualization,analysis,cloud]'

服务器配置

MCP 客户端需要配置以下 JSON 格式信息以连接 TSAP MCP Server：

{
  "serverName": "tsap_mcp_server",
  "command": "tsap",
  "args": ["server"]
}

配置参数说明:

'serverName': 服务器名称，可以自定义，用于在客户端标识服务器。
'command': 启动 TSAP MCP Server 的命令，这里是 'tsap'。
'args': 传递给启动命令的参数，这里使用 '["server"]' 来运行服务器模式。

基本使用方法

启动服务器: 在终端中运行以下命令启动 TSAP MCP Server：
```
tsap server
```
通过 MCP 客户端连接: 配置 MCP 客户端，使用上述提供的服务器配置信息连接到 TSAP MCP Server。客户端即可通过 MCP 协议与服务器进行通信，调用服务器提供的各种文本处理工具和分析功能。

Python 客户端示例 (仓库提供): 仓库的 'README.md' 中提供了一个 Python 客户端的示例，展示了如何通过 TSAP 提供的库来调用服务器功能 (但这并非 MCP 客户端，而是直接调用 TSAP 库的方法，MCP客户端应通过JSON-RPC与server通信)。例如：

from tsap.core import ripgrep_tool
from tsap.composite import parallel_search

# 搜索多个模式
results = parallel_search(
    patterns=[
        {"pattern": "api_key", "description": "Generic API key"},
        {"pattern": "password", "description": "Password"}
    ],
    file_types=["py", "js"]
)

注意: 实际 MCP 客户端的使用方式会依赖于具体的客户端实现。上述 Python 示例仅为演示 TSAP 功能，而非 MCP 客户端的典型用法。MCP 客户端应通过 JSON-RPC 协议发送符合 MCP 规范的请求到 TSAP MCP Server。

查看示例: 仓库的 'examples/' 目录下提供了更多实际使用案例，可以参考学习如何利用 TSAP MCP Server 完成各种文本处理任务。

关键词