使用说明
项目简介
本项目是一个基于Model Context Protocol (MCP) 的服务器实现,专为Drupal内容管理系统设计。它充当桥梁,使得大型语言模型 (LLM) 客户端能够通过标准化的MCP协议,安全、便捷地访问和利用Drupal网站中托管的内容资源、功能工具和预定义的Prompt模板。
主要功能点
- 资源 (Resources): 将Drupal API 定义的各种数据实体(如文章、用户、分类等)作为MCP资源暴露给LLM客户端,允许LLM读取和利用Drupal网站的内容信息。
- 工具 (Tools): 集成Drupal API 提供的各种功能接口,注册为MCP工具,使LLM客户端能够调用Drupal的功能,例如内容检索、用户操作等。
- Prompt 模板 (Prompts): 支持在Drupal中定义和管理Prompt模板,为LLM客户端提供可定制的交互模式,优化LLM在特定Drupal应用场景下的表现。
- 基于标准MCP协议: 遵循MCP协议规范,通过JSON-RPC over Stdio 与客户端通信,确保与各种MCP兼容的LLM客户端的互操作性。
- 易于集成: 提供清晰的安装和配置指南,方便Drupal开发者快速部署和使用MCP服务器。
安装步骤
- 安装依赖: 确保你的开发环境中已安装 Bun。在项目根目录下运行以下命令安装项目依赖:
bun install - 构建服务器: 运行以下命令构建可执行的服务器文件:
构建成功后,会在项目目录下生成可执行文件。bun run build
服务器配置
要将此MCP服务器与MCP客户端(例如 Claude Desktop)配合使用,您需要配置客户端以连接到此服务器。以下是 Claude Desktop 的配置示例,你需要将配置信息添加到 'claude_desktop_config.json' 文件中。
Claude Desktop 配置示例 (JSON):
{ "mcpServers": { "mcp-server-drupal": { "command": "__BINARY_PATH__", "args": ["--drupalBaseUrl", "__DRUPAL_BASE_URL__"], "env": {} } } }
配置参数说明:
- '"mcp-server-drupal"': 服务器名称,可以自定义,用于在客户端中标识该服务器。
- '"command"': [必填] MCP服务器的可执行文件路径。你需要将 '"BINARY_PATH"' 替换为实际的服务器可执行文件路径。通常是项目构建后生成的 'index.js' 文件,例如:'/path/to/omedia_mcp-server-drupal/index.js'。
- '"args"': [必填] 传递给服务器的启动参数,以数组形式提供。
- '"--drupalBaseUrl"': 指定Drupal网站的根URL。你需要将 '"DRUPAL_BASE_URL"' 替换为你的Drupal网站的实际URL,例如:'https://your-drupal-site.com'。
- '"env"': [可选] 环境变量配置,如果服务器需要额外的环境变量,可以在这里设置。当前示例为空。
配置步骤:
- 找到 'claude_desktop_config.json' 文件:
- MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
- 编辑配置文件: 使用文本编辑器打开 'claude_desktop_config.json' 文件,将上面的 JSON 配置示例添加到 '"mcpServers"' 字段中。
- 替换占位符: 根据你的实际情况,将 '"BINARY_PATH"' 和 '"DRUPAL_BASE_URL"' 替换为正确的值。
基本使用方法
-
启动 MCP 服务器: 在终端中,导航到项目根目录,并运行以下命令启动服务器 (开发模式,带自动重启):
bun run dev或者运行构建后的可执行文件 (生产模式):
node <实际的服务器可执行文件路径> --drupalBaseUrl <你的Drupal网站URL>例如:
node /path/to/omedia_mcp-server-drupal/index.js --drupalBaseUrl https://your-drupal-site.com服务器成功启动后,会在终端输出 "Drupal MCP server is running" 的信息。
-
配置 MCP 客户端: 根据你使用的 MCP 客户端(例如 Claude Desktop)的文档,配置连接到你刚刚启动的 MCP 服务器。通常需要提供服务器名称、启动命令和参数等信息,这些信息已在上面的 "服务器配置" 部分提供。
-
在 MCP 客户端中使用: 客户端成功连接到 MCP 服务器后,你就可以在客户端中体验 Drupal 网站提供的资源和工具了。具体使用方式取决于客户端的功能和界面。
调试
如果需要调试 MCP 服务器,可以使用 MCP Inspector 工具。按照 'README.md' 中的说明,运行 'bun run inspector' 命令,即可通过浏览器访问调试工具。
信息
分类
生产力应用