使用说明

项目简介

Function App Tester 是一个基于 TypeScript 开发的 MCP 服务器,它允许你通过 Cline 这类 MCP 客户端工具来测试 Azure Function Apps 的端点。你可以使用这个服务器方便地在开发环境中与 Function App 交互,发送各种 HTTP 请求并查看详细的响应信息。

主要功能点

  • 测试 Function App 端点:支持 GET, POST, PUT, DELETE 等 HTTP 方法,可以测试 Function App 暴露的各种 API 接口。
  • 查看详细响应:返回请求的完整 URL, HTTP 状态码, 状态文本, 响应头和响应体,方便调试和验证 API 行为。
  • 自定义请求头:允许在请求中添加自定义 HTTP 请求头,以满足不同的 API 认证或请求配置需求。
  • 处理请求体:支持 POST/PUT 请求的 JSON 格式请求体,可以模拟客户端向 Function App 发送数据。
  • 多种认证方式:内置支持 Basic Authentication, Bearer Token Authentication 和 API Key Authentication,可以方便地测试需要认证的 Function App 端点。

安装步骤

  1. 确保你的开发环境中已经安装了 Node.js 和 npm (或 yarn)。
  2. 打开终端,运行以下命令全局安装 'dkmaker-mcp-function-app-tester' 包:
    npm install -g dkmaker-mcp-function-app-tester
    (使用 '-g' 参数进行全局安装,以便 'mcp-function-app-tester' 命令可以在任何路径下直接运行)

服务器配置

要将 Function App Tester 作为 MCP 服务器与 MCP 客户端(如 Cline)连接,你需要在客户端中配置服务器的启动信息。以下是一个典型的 JSON 格式配置示例,你需要将其添加到你的 MCP 客户端配置中:

{
  "serverName": "function-app-tester",
  "command": "mcp-function-app-tester",
  "args": []
}
  • 'serverName': 为该服务器配置的名称,可以自定义,例如 "function-app-tester"。这个名称用于在 MCP 客户端中标识和管理不同的 MCP 服务器。
  • 'command': 启动 Function App Tester 服务器的命令。全局安装后,'mcp-function-app-tester' 命令可以直接在终端中执行。
  • 'args': 启动命令的参数列表。Function App Tester 服务器本身不需要额外的命令行参数,因此这里配置为空数组 '[]'。

环境变量配置 (可选): Function App Tester 服务器允许通过环境变量进行一些可选配置,例如 Function App 的基础 URL 和认证信息。你可以在运行服务器的环境中设置以下环境变量:

  • 'FUNCTION_APP_BASE_URL': 指定 Function App 的基础 URL。默认为 'http://localhost:7071/api'。如果你的 Function App 部署在不同的地址,可以通过设置此环境变量来更改。
  • 'AUTH_BASIC_USERNAME', 'AUTH_BASIC_PASSWORD': 配置 Basic Authentication 的用户名和密码。如果你的 Function App 端点需要 Basic Auth 认证,设置这两个环境变量后,服务器会自动在请求中添加 Basic Auth Header。
  • 'AUTH_BEARER': 配置 Bearer Token Authentication 的 Token。设置此环境变量后,服务器会自动在请求中添加 Bearer Token Header。
  • 'AUTH_APIKEY_HEADER_NAME', 'AUTH_APIKEY_VALUE': 配置 API Key Authentication 的 Header 名称和 Key 值。设置这两个环境变量后,服务器会自动在请求中添加 API Key Header。

基本使用方法

  1. 启动 MCP 客户端,并在客户端的服务器配置中添加上面提供的 Function App Tester 服务器配置。

  2. 确保 Function App Tester 服务器已成功启动并与 MCP 客户端建立连接。

  3. 在 MCP 客户端中,你可以使用 'test_endpoint' 工具来测试 Function App 的端点。通过向 MCP 服务器发送 'CallToolRequest' 请求,调用 'test_endpoint' 工具并提供相应的参数。

  4. 以下是一些调用 'test_endpoint' 工具的示例请求 (JSON 格式):

    测试 GET 请求:

    {
      "tool_call": {
        "tool_name": "test_endpoint",
        "tool_arguments": {
          "method": "GET",
          "endpoint": "/your-endpoint"
        }
      }
    }

    测试 POST 请求 (带请求体和自定义 Header):

    {
      "tool_call": {
        "tool_name": "test_endpoint",
        "tool_arguments": {
          "method": "POST",
          "endpoint": "/your-endpoint",
          "body": { "key": "value" },
          "headers": { "Content-Type": "application/json", "X-Custom-Header": "custom-value" }
        }
      }
    }
  5. MCP 客户端会收到 MCP 服务器返回的 'ToolCallResponse' 响应,其中 'content' 字段包含了 Function App 端点请求的详细响应信息(URL, 状态码, 响应头, 响应体)。

信息

分类

开发者工具