@leeguoo/yapi-mcp 0.2.0

package/dist/services/yapi/types.d.ts

@@ -0,0 +1,102 @@
+export interface ApiInterface {
+    _id: string;
+    project_id?: number | string;
+    catid?: string;
+    status?: string;
+    tag?: string[];
+    title: string;
+    path: string;
+    method: string;
+    req_params: any[];
+    req_body_form: any[];
+    req_headers: any[];
+    req_query: any[];
+    req_body_type: string;
+    req_body_other: string;
+    req_body_is_json_schema?: boolean;
+    res_body_type: string;
+    res_body: string;
+    res_body_is_json_schema?: boolean;
+    switch_notice?: boolean;
+    api_opened?: boolean;
+    desc: string;
+    markdown: string;
+    message?: string;
+}
+export interface SaveApiInterfaceParams {
+    id?: string;
+    catid: string;
+    token?: string;
+    method: string;
+    path: string;
+    title: string;
+    project_id: string;
+    req_params?: any[];
+    req_headers?: any[];
+    req_query?: any[];
+    req_body_type?: string;
+    req_body_form?: any[];
+    req_body_other?: string;
+    req_body_is_json_schema?: boolean;
+    res_body_type?: string;
+    res_body?: string;
+    res_body_is_json_schema?: boolean;
+    desc?: string;
+    markdown?: string;
+    switch_notice?: boolean;
+    api_opened?: boolean;
+    tag?: string[];
+    status?: string;
+}
+export interface ProjectInfo {
+    _id: number | string;
+    name: string;
+    desc: string;
+    group_id: number;
+    uid: number;
+    basepath: string;
+}
+export interface CategoryInfo {
+    _id: string;
+    name: string;
+    desc: string;
+    project_id: number | string;
+    uid: number;
+    add_time: number;
+    up_time: number;
+    index: number;
+}
+export interface ApiSearchResultItem {
+    _id: string;
+    title: string;
+    path: string;
+    method: string;
+    project_id: number | string;
+    catid: string;
+    add_time: number;
+    up_time: number;
+    project_name?: string;
+    cat_name?: string;
+}
+export interface ApiResponse<T> {
+    errcode: number;
+    errmsg: string;
+    data: T;
+}
+export interface GetApiResponse extends ApiResponse<ApiInterface> {
+}
+export interface GetProjectResponse extends ApiResponse<ProjectInfo> {
+}
+export interface GetCategoryListResponse extends ApiResponse<CategoryInfo[]> {
+}
+export interface SaveApiResponse extends ApiResponse<{
+    _id: string;
+    [key: string]: any;
+}> {
+}
+export interface ApiSearchResponse extends ApiResponse<{
+    total: number;
+    count: number;
+    list: ApiSearchResultItem[];
+}> {
+}

package/dist/services/yapi/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/services/yapi/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/yapi/types.ts"],"names":[],"mappings":""}

package/dist/services/yapi.d.ts

@@ -0,0 +1,28 @@
+export interface ApiInterface {
+    _id: string;
+    title: string;
+    path: string;
+    method: string;
+    req_params: any[];
+    req_body_form: any[];
+    req_headers: any[];
+    req_query: any[];
+    req_body_type: string;
+    res_body_type: string;
+    res_body: string;
+    desc: string;
+    markdown: string;
+}
+export interface GetApiResponse {
+    errcode: number;
+    errmsg: string;
+    data: ApiInterface;
+}
+export declare class YApiService {
+    private readonly baseUrl;
+    private readonly token;
+    private readonly logger;
+    constructor(baseUrl: string, token: string);
+    private request;
+    getApiInterface(id: string): Promise<ApiInterface>;
+}

package/dist/services/yapi.js

@@ -0,0 +1,84 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.YApiService = void 0;
+const axios_1 = __importStar(require("axios"));
+const logger_1 = require("./yapi/logger");
+class YApiService {
+    baseUrl;
+    token;
+    logger;
+    constructor(baseUrl, token) {
+        this.baseUrl = baseUrl;
+        this.token = token;
+        this.logger = new logger_1.Logger("YApiService", "debug");
+    }
+    async request(endpoint, params = {}) {
+        try {
+            this.logger.debug(`调用 ${this.baseUrl}${endpoint}`);
+            const response = await axios_1.default.get(`${this.baseUrl}${endpoint}`, {
+                params: {
+                    ...params,
+                    token: this.token
+                }
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error instanceof axios_1.AxiosError && error.response) {
+                throw {
+                    status: error.response.status,
+                    message: error.response.data.errmsg || "未知错误",
+                };
+            }
+            throw new Error("与YApi服务器通信失败");
+        }
+    }
+    async getApiInterface(id) {
+        try {
+            const response = await this.request("/api/interface/get", { id });
+            if (response.errcode !== 0) {
+                throw new Error(response.errmsg || "获取API接口失败");
+            }
+            return response.data;
+        }
+        catch (error) {
+            console.error("获取API接口失败:", error);
+            throw error;
+        }
+    }
+}
+exports.YApiService = YApiService;
+//# sourceMappingURL=yapi.js.map

package/dist/services/yapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yapi.js","sourceRoot":"","sources":["../../src/services/yapi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA0C;AAC1C,0CAAuC;AAyBvC,MAAa,WAAW;IACL,OAAO,CAAS;IAChB,KAAK,CAAS;IACd,MAAM,CAAS;IAEhC,YAAY,OAAe,EAAE,KAAa;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,OAAO,CAAI,QAAgB,EAAE,SAA8B,EAAE;QACzE,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC,CAAC;YACnD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,EAAE;gBAC7D,MAAM,EAAE;oBACN,GAAG,MAAM;oBACT,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB;aACF,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,kBAAU,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAClD,MAAM;oBACJ,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM;oBAC7B,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,MAAM;iBAC9C,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU;QAC9B,IAAI,CAAC;YAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB,oBAAoB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAGlF,IAAI,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC;YAClD,CAAC;YAED,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAjDD,kCAiDC"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@leeguoo/yapi-mcp",
+  "version": "0.2.0",
+  "description": "YApi Auto MCP Server - Model Context Protocol server for YApi integration, enables AI tools like Cursor to interact with YApi API documentation",
+  "main": "dist/index.js",
+  "bin": {
+    "yapi-auto-mcp": "./dist/cli.js",
+    "yapi-mcp": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "type-check": "tsc --noEmit",
+    "start": "node dist/index.js",
+    "start:cli": "cross-env NODE_ENV=cli node dist/index.js",
+    "start:http": "node dist/index.js",
+    "dev": "cross-env NODE_ENV=development tsx watch src/index.ts",
+    "dev:cli": "cross-env NODE_ENV=development tsx watch src/index.ts --stdio",
+    "lint": "eslint . --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "inspect": "pnpx @modelcontextprotocol/inspector",
+    "prepare": "pnpm run build && chmod +x ./dist/cli.js",
+    "pub:release": "pnpm build && npm publish"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/leeguooooo/Yapi-MCP.git"
+  },
+  "keywords": [
+    "yapi",
+    "mcp",
+    "typescript",
+    "model-context-protocol",
+    "api-documentation",
+    "cursor",
+    "ai-tools",
+    "api-management",
+    "yapi-integration",
+    "claude",
+    "anthropic",
+    "ai-assistant",
+    "interface-management",
+    "api-design",
+    "documentation-tool"
+  ],
+  "author": "liangzhensheng <372959130@qq.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.6.0",
+    "@types/yargs": "^17.0.33",
+    "axios": "^1.7.9",
+    "dotenv": "^16.4.7",
+    "express": "^4.21.2",
+    "remeda": "^2.20.1",
+    "yargs": "^17.7.2",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^20.17.32",
+    "@typescript-eslint/eslint-plugin": "^8.24.0",
+    "@typescript-eslint/parser": "^8.24.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.20.1",
+    "eslint-config-prettier": "^10.0.1",
+    "prettier": "^3.5.0",
+    "tsc-alias": "^1.8.10",
+    "tsx": "^4.19.3",
+    "typescript": "^5.7.3"
+  }
+}