FlowMCP

FlowMCP 提供了一种声明式和模块化的方法，通过统一的 schema 系统和基于 zod 的验证来集成各种 REST API。 它的目标是使 API 易于使用、测试和扩展，即使它们在结构和设计上差异很大。

特性

• 从 API schema 自动生成 zod 接口
• REST 端点的标准化路由
• 内置测试生成
• 通过 modifiers 支持 API 特定的转换逻辑
• 使用类似 JSON 的 schema 定义轻松扩展

快速开始

安装

npm install a6b8/flowMCP#beta

示例用法

定义您的 API schema (例如 testSchema.mjs) 并使用 FlowMCP 执行请求：

import { testSchema as schema } from "./tests/data/testSchema.mjs";
import { FlowMCP } from "flowmcp";

const serverParams = { ETHERSCAN_API_KEY: 'your-api-key-here' };

// 加载自动生成的测试
const tests = FlowMCP.getAllTests({ schema });
const [routeName, userParams] = tests[0];

// 执行 API 请求
const { status, messages, data } = await FlowMCP.fetch({
  schema,
  userParams,
  serverParams,
  routeName
});

console.log('status:', status);
console.log('data:', data);

目录

• FlowMCP
  • 特性
  • 快速开始
    • 安装
    • 示例用法
  • 目录
  • 概述
  • 方法
    • getZodInterfaces({ schema })
    • getAllTests({ schema })
    • fetch({ schema, userParams, serverParams, routeName })
  • Schema
  • 许可

概述

FlowMCP 的核心是一个声明式的 API schema，它定义了接口的所有方面：端点、参数、验证、测试和处理逻辑。 FlowMCP 将此 schema 转换为功能齐全、经过测试的 API 客户端。

方法

getZodInterfaces({ schema })

从 schema 生成基于 zod 的验证接口。

FlowMCP.getZodInterfaces({ schema });

getAllTests({ schema })

返回 schema 中定义的所有测试用例。

const tests = FlowMCP.getAllTests({ schema });

fetch({ schema, userParams, serverParams, routeName })

执行 schema 中定义的 API 请求。

const result = await FlowMCP.fetch({
  schema,
  userParams,
  serverParams,
  routeName
});

Schema

一个兼容的（简化的）schema 示例：

const testSchema = {
  root: "https://api.etherscan.io",
  vars: ["ETHERSCAN_API_KEY"],
  routes: {
    getContractABI: {
      requestMethod: "GET",
      description: "返回已验证智能合约的合约 ABI。",
      route: "/api",
      parameters: [
        { position: ["module", "contract", "query"] },
        { position: ["action", "getabi", "query"] },
        { position: ["address", "{{USER_PARAM}}", "query"], z: ["string", "min(42)", "max(42)"] },
        { position: ["apikey", "{{ETHERSCAN_API_KEY}}", "query"] }
      ],
      tests: [
        {
          _description: "getContractABI 的基本测试",
          address: "0xBB9bc244D798123fDe783fCc1C72d3Bb8C189413"
        }
      ],
      modifiers: [["post", "convertToJSON"]]
    }
  },
  modifiers: {
    convertToJSON: async (struct) => {
      if (struct.data.status !== "1") {
        struct.status = false;
        struct.messages.push(struct.data.message);
        return struct;
      }
      struct.data = struct.data.result;
      return struct;
    }
  }
};

许可

该项目根据 MIT 许可证获得许可 – 有关详细信息，请参阅 LICENSE 文件。