使用说明

项目简介

本仓库实现了一个基于 Model Context Protocol (MCP) 的服务器,旨在为LLM客户端提供额外的工具能力。通过此服务器,LLM可以访问互联网内容、本地PDF文件内容,甚至执行预设的系统命令,从而增强其处理复杂任务的能力。

主要功能点

  • 网页内容提取 (get-webpage-markdown): 允许LLM获取指定URL网页的Markdown格式文本内容,用于理解网页信息或进行内容摘要。
  • PDF内容提取 (get-pdf-content): 允许LLM读取本地PDF文件的文本内容,使其能够处理和分析PDF文档。
  • 命令执行 (command-execute): 允许LLM执行预定义的安全命令列表(如 'ls', 'mkdir', 'cd', 'npm', 'npx', 'node', 'git', 'rm'),扩展LLM与环境的交互能力,例如执行代码构建、文件管理等操作(请注意安全性,仅限开发和个人使用场景)。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node.js 包管理器)。
  2. 下载仓库代码: 从 GitHub 仓库 'https://github.com/shin-t-o/mcp-access' 下载代码到本地。
  3. 安装依赖: 在仓库根目录下打开终端,运行以下命令安装项目依赖:
    npm ci
  4. 构建项目: 运行以下命令构建项目,生成可执行的 JavaScript 文件:
    npm run build
    构建成功后,会在 'dist' 目录下生成 'index.js' 文件。

服务器配置

MCP客户端需要配置MCP服务器的启动命令才能连接。以下是针对本仓库的 'claude_desktop_config.json' 配置示例,你需要根据实际情况修改 'path/to/dist/index.js' 为 'dist/index.js' 文件在你电脑上的 绝对路径

{
  "mcpServers": {
    // "mcp-access" 是你为该服务器自定义的名称,可以随意修改
    "mcp-access": {
      // command 指定启动服务器的命令,这里使用 node 解释器
      "command": "node",
      // args 是传递给 command 的参数,这里指定了服务器入口文件 dist/index.js 的路径
      // 请将 "path/to/dist/index.js" 替换为 dist/index.js 文件在你电脑上的绝对路径,例如 "/Users/yourname/Downloads/mcp-access/dist/index.js" (macOS/Linux) 或 "C:\\Users\\YourName\\Downloads\\mcp-access\\dist\\index.js" (Windows)
      "args": ["path/to/dist/index.js"]
    }
  }
}

注意:

  • 请务必将 'path/to/dist/index.js' 替换为实际的 'dist/index.js' 文件路径。可以使用绝对路径,以确保客户端能正确找到并启动服务器。
  • 'mcp-access' 字段名可以自定义,用于在客户端中标识和选择该服务器。

基本使用方法

  1. 配置MCP客户端: 在你的MCP客户端(例如 Claude 桌面应用或其他支持 MCP 协议的 LLM 应用)中,根据客户端的指引配置 MCP 服务器。通常需要编辑一个配置文件(如 'claude_desktop_config.json'),将上述服务器配置信息添加到配置文件中。
  2. 启动MCP服务器: 当客户端尝试连接到 'mcp-access' 服务器时,客户端会根据配置的 'command' 和 'args' 启动 'dist/index.js' 文件,从而启动 MCP 服务器。
  3. 在LLM中使用工具: 在LLM的Prompt中,你可以指示LLM使用以下工具来完成特定任务:
    • 网页内容提取: '使用 get-webpage-markdown 工具并提供网页URL,例如:请使用 get-webpage-markdown 工具分析这个网页的内容 -> http://example.com'
    • PDF内容提取: '使用 get-pdf-content 工具并提供PDF文件路径,例如:请使用 get-pdf-content 工具读取并总结当前目录下的 document.pdf 文件' (文件路径需要是服务器能够访问的路径)
    • 命令执行: '使用 command-execute 工具并提供命令和工作目录,例如:请使用 command-execute 工具在当前目录下执行 npm install 命令' (请谨慎使用命令执行工具,确保只执行可信命令,并注意安全风险)

安全提示: 'command-execute' 工具具有潜在的安全风险,请仅在受信任的环境中使用,并仔细审查允许执行的命令列表 ('DEFAULT_ALLOWED_COMMANDS')。开发者可以根据需要修改允许的命令列表。

信息

分类

AI与计算