使用说明

项目简介

Acuvity MCP 服务器是一个基于 Typescript 开发的 Model Context Protocol (MCP) 服务器，它将 Acuvity 的 Apex API 功能以标准化的 MCP 协议形式对外暴露，使得 AI 应用程序能够便捷地调用 Acuvity 的内容安全检测能力。该服务器主要集成了 Apex API 的扫描和分析器列表功能，为 AI 应用提供prompt注入、恶意内容、PII 和敏感信息检测等安全服务。

主要功能点

资源管理 (Resources): 虽然仓库文档中没有明确提及资源管理，但 MCP 服务器的定义包含资源管理，理论上可以通过扩展实现资源托管和数据访问能力。
工具注册和执行 (Tools): 已注册并实现了 'apex_scan-request' (内容扫描) 和 'apex_list-analyzers' (分析器列表) 两个核心工具，允许 LLM 客户端调用 Acuvity Apex API 的功能。
Prompt 模板 (Prompts): 仓库本身未直接提供 Prompt 模板功能，但作为 MCP 服务器，具备支持 Prompt 模板定义和渲染的潜力，可以通过扩展实现。
标准 MCP 协议: 基于 JSON-RPC 协议与客户端通信，支持 Stdio 和 SSE 传输协议，符合 MCP 服务器的基本规范。
会话管理和能力声明: MCP 服务器端负责会话管理和能力声明（已声明 'apex_scan-request' 和 'apex_list-analyzers' 工具）。

安装步骤

环境准备: 确保已安装 Node.js v20 或更高版本。
安装 SDK: 使用 npm, pnpm, bun 或 yarn 等包管理器安装 '@acuvity/acuvity' 包。

例如使用 npm 安装：
```
npm add @acuvity/acuvity
```

服务器配置

MCP 服务器是为 MCP 客户端（如 Claude, Cursor 等）提供服务的后端应用。客户端需要配置服务器的启动命令和参数才能连接。以下是配置信息示例（JSON 格式），请根据您的 MCP 客户端进行相应配置。

{
  "server name": "Acuvity",  // MCP 服务器名称，可自定义
  "command": "npx", // 启动命令，通常为 npx 或 node
  "args": [ // 启动参数列表
    "-y", // npx 参数，自动确认安装包
    "--package", // npx 参数，指定要执行的 npm 包
    "@acuvity/acuvity", // 要执行的 npm 包名称，即 Acuvity SDK
    "--", // 分隔 npx 参数和 npm 包的参数
    "mcp", //  Acuvity SDK 提供的 mcp 命令
    "start", // mcp 命令的子命令，启动 MCP 服务器
    "--api-token", "YOUR_API_TOKEN", // (必填) Acuvity Apex API 的访问令牌，请替换为您的实际令牌
    "--cookie", "YOUR_COOKIE" // (可选) Acuvity Apex API 的 Cookie，如果使用令牌认证，则此参数可选
    // "--transport", "sse", // (可选) 传输协议，默认为 stdio，可设置为 sse
    // "--port", "2718", // (可选) SSE 传输协议端口，默认为 2718，仅当 transport 为 sse 时生效
    // "--log-level", "debug" // (可选) 日志级别，默认为 info，可选值：debug, warning, info, error
  ]
}

注意:

请将 'YOUR_API_TOKEN' 替换为您在 Acuvity Apex API 获取的实际 API 令牌。如果使用 Cookie 认证，请替换 'YOUR_COOKIE'。
'command' 和 'args' 字段用于配置 MCP 客户端如何启动和连接到 Acuvity MCP 服务器。请根据您的客户端配置界面的要求填写。
'--transport' 和 '--port' 参数用于配置服务器的传输协议和端口。如果使用 SSE 协议，请确保客户端和服务端配置一致。
'--log-level' 参数用于设置服务器的日志输出级别，方便调试和监控。

基本使用方法

启动 MCP 服务器: 在安装 SDK 的环境下，根据上述配置在 MCP 客户端中启动 Acuvity MCP 服务器。
配置 MCP 客户端: 在 MCP 客户端中配置连接到 Acuvity MCP 服务器，客户端将自动发现服务器提供的工具和功能。
在 AI 应用中使用工具: 在支持 MCP 协议的 AI 应用中，可以通过标准的 MCP 接口调用 'apex_scan-request' 和 'apex_list-analyzers' 等工具，利用 Acuvity Apex API 的内容安全检测能力。

例如，在 Claude 客户端中配置并连接 Acuvity MCP 服务器后，即可在 Claude 的对话中使用 'apex_scan-request' 工具来扫描文本内容，检测潜在的安全风险。

关键词

使用说明

信息