项目简介

本项目是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在作为大型语言模型（LLM）客户端与 Accord Project Agreement Protocol (APAP) 后端服务之间的桥梁。它允许 LLM 通过标准的 MCP 请求，访问和操作 Accord Project 平台上的智能合约模板和协议实例。

主要功能点

• 资源访问: 允许 LLM 客户端列出、查看和读取 Accord Project 平台上的智能合约模板和协议（Agreement）的详细信息。
• 工具执行: 提供一系列可供 LLM 调用的工具，用于创建新的智能合约模板和协议，以及触发协议中的条款。
• Prompt 模板: 定义预设的交互模式，帮助 LLM 客户端理解如何与服务器交互以完成特定任务（例如列出、查看、创建、触发）。

安装步骤

1. 安装 Node.js 和 npm: 确保您的系统已安装 Node.js 环境和 npm 包管理器。
2. 克隆仓库: 使用 Git 命令克隆本项目的代码库到您的本地计算机。
3. 安装依赖: 在项目根目录下打开终端，运行 'npm install' 安装所需的依赖库。
4. 构建项目: 运行 'npm run build' 命令，将 TypeScript 源代码编译为 JavaScript。这会生成一个可运行的 'build/apap.js' 文件。

服务器配置

该 MCP 服务器需要由支持 MCP 的 LLM 客户端（如 Claude Desktop）启动和管理。客户端通常通过一个配置文件来指定如何启动 MCP 服务器以及传递必要的参数和环境变量。

以下是配置此 MCP 服务器所需的关键信息，您需要在LLM客户端的配置中提供：

• 服务器名称 (server name): 例如 'Accord' 或其他您希望在客户端中显示的名称。
• 启动命令 (command): 用于执行服务器的可执行程序路径。对于 Node.js 应用，这通常是 'node' 命令的绝对路径。
• 启动参数 (args): 传递给启动命令的参数。对于本项目，核心参数是构建生成的服务器脚本路径，例如：'/path/to/your/clone/accord-project-mcp/build/apap.js'。您需要替换为实际文件路径。
• 环境变量 (env): 服务器运行时需要的环境变量。
  • 'APAP_BASE_URL': 指向 Accord Project APAP 后端服务的 URL，包括协议和端口号，例如 'http://localhost:3000'。 此项是必需的。
  • 'JWT_TOKEN': 如果您的 APAP 后端需要 JWT 认证，在此处提供有效的 JWT 令牌。此项是可选的，取决于您的 APAP 后端配置。

注意： 具体的配置方式和文件路径取决于您使用的 LLM 客户端。请查阅您客户端的文档以获取详细的 MCP 服务器配置指南。

基本使用方法

配置完成后，启动您的 LLM 客户端。如果客户端正确集成了 MCP 功能并加载了本服务器，您应该能在客户端的用户界面中看到由本服务器提供的功能，例如：

• 资源列表: 查找一个通常表示可访问数据的图标（例如插头图标），点击它应该能看到本服务器提供的资源列表，如“List Templates”、“List Agreements”以及具体的模板和协议ID。点击这些资源可以获取它们的详情。
• 工具列表: 查找一个通常表示工具或外部功能的图标（例如锤子图标），点击它应该能看到本服务器提供的工具列表，如 'getTemplate', 'getAgreement', 'createAgreement', 'trigger', 'createTemplate'。LLM 可以利用这些工具来执行相应的操作。
• Prompt 快捷方式: 客户端可能会根据服务器定义的 Prompt 模板提供对话快捷方式，例如“List all available templates”或“Create Agreement”。

通过与 LLM 自然语言交流，并结合客户端提供的资源访问和工具调用界面，您可以指示 LLM 完成与 Accord Project 智能合约的交互，例如：

1. 要求 LLM 列出所有可用的模板。
2. 要求 LLM 查看某个特定模板的详细信息。
3. 要求 LLM 使用某个模板和提供的数据创建一个新的协议。
4. 要求 LLM 触发某个协议中的条款，并提供触发所需的请求数据。

重要提示: 使用 LLM 触发协议条款或创建新模板/协议时请务必谨慎，确认操作和数据无误，避免意外修改或生成内容。