✨ feat: 配置增加 MCP 支持

Author: MaLuns

.github/workflows/publish-mcp.yml

@@ -0,0 +1,30 @@
+name: NPM Publish
+
+on:
+  push:
+    tags:
+      - "mcp-v*"
+jobs:
+  build:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: "https://registry.npmjs.org"
+          cache: yarn
+      - run: yarn install --frozen-lockfile
+
+      - name: Build
+        run: |
+          cp ./packages/vitepress-theme-async/types/theme.d.ts ./packages/mcp-server/lib
+          node ./scripts/publish.mjs
+          cd ./packages/mcp-server
+          npm publish
+        env:
+          RELEASE_VERSION: ${{ github.ref }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

packages/mcp-server/README.md

@@ -0,0 +1,46 @@
+# Vitepress-theme-async MCP Server
+
+使用 Vitepress-theme-async MCP Server，可以将主题配置说明信息当做数据源提供给 Cursor 等支持 AI 编程的 IDE 工具以便让 AI 能够直接根据你的需求修改配置。
+
+通过 MCP 可以免去了你需要去查阅文档，或者去查看主题源码的麻烦，直接让 AI 帮你修改主题配置。
+
+## 🎯 如何使用
+
+安装配置好 MCP 后，AI 可以通过 MCP 读取主题配置说明信息。
+
+你只要告诉 AI 你想要通过 修改主题配置信息，示例：
+
+- “主题 vitepress-theme-async 有哪些配置信息”
+- “帮我修改 banner 配置, 将背景图换成 xxxx ”
+- “帮我修改 关于我 页面配置”
+- “.......”
+
+## 🚀 安装方法
+
+### 前置条件
+
+- 已安装 Node.js 环境（版本号 >= 18，推荐最新的 LTS 版本）
+- 任意一个支持 MCP 的 IDE：
+    - Cursor
+    - VSCode + Cline 插件
+    - ......
+
+### 安装
+
+将下面 JSON 配置添加到 IDE 对应的 MCP 配置文件里：
+
+``` json
+{
+  "mcpServers": {
+    "async配置": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "vitepress-theme-async-mcp-server@latest",
+      ]
+    }
+  }
+}
+```
+
+目前 MCP Server 仅提供 AI 配置文件详细说明，更细致化自定义功能还不支持。

packages/mcp-server/lib/index.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+import { Server } from '@modelcontextprotocol/sdk/server/index.js';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { CallToolRequestSchema, ListToolsRequestSchema, } from '@modelcontextprotocol/sdk/types.js';
+import { readFileSync } from 'fs'
+import { resolve } from 'path';
+
+const text = readFileSync(resolve(__dirname, 'theme.d.ts'), {
+    encoding: 'utf-8'
+});
+
+class AsyncConfigServer {
+    server;
+    constructor() {
+        this.server = new Server({
+            name: 'vitepress-theme-async-server',
+            version: '1.0.0',
+        }, {
+            capabilities: {
+                tools: {},
+            },
+        });
+        this.setupToolHandlers();
+    }
+    setupToolHandlers() {
+        this.server.setRequestHandler(ListToolsRequestSchema, async () => {
+            return {
+                tools: [
+                    {
+                        name: 'async_config_doc',
+                        description: 'vitepress-theme-async 主题配置的描述文件，当用户询问主题配置时，可以调用此工具获取参考配置信息，采用的是 .d.ts 详细描述了主题配置格式',
+                        inputSchema: {
+                            type: 'object',
+                            properties: {},
+                        },
+                    },
+                ],
+            };
+        });
+        this.server.setRequestHandler(CallToolRequestSchema, async (request) => {
+            const { name } = request.params;
+            switch (name) {
+                case 'async_config_doc':
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: text,
+                            },
+                        ],
+                    };
+                default:
+                    throw new Error(`未知工具: ${name}`);
+            }
+        });
+    }
+    async run() {
+        const transport = new StdioServerTransport();
+        await this.server.connect(transport);
+        console.error('Example MCP Server 已启动');
+    }
+}
+
+const server = new AsyncConfigServer();
+server.run().catch((error) => {
+    console.error('服务器启动失败:', error);
+    process.exit(1);
+});

packages/mcp-server/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "vitepress-theme-async-mcp-server",
+    "version": "0.0.0",
+    "repository": "git@github.com:MaLuns/vitepress-theme-async.git",
+    "author": "白云苍狗 <admin@imalun.com>",
+    "homepage": "https://vitepress-theme-async.imalun.com",
+    "bugs": {
+        "url": "https://github.com/MaLuns/vitepress-theme-async/issues"
+    },
+    "license": "MIT",
+    "type": "module",
+    "main": "lib/index.js",
+    "bin": {
+        "apifox-mcp-server": "lib/index.js"
+    },
+    "files": [
+        "lib",
+        "README.md"
+    ],
+    "keywords": [
+        "vitepress-theme",
+        "blog-theme"
+    ],
+    "scripts": {
+        "test": "ec"
+    },
+    "dependencies": {
+        "@modelcontextprotocol/sdk": "^0.5.0"
+    }
+}

scripts/publish.mjs

@@ -3,13 +3,16 @@ import { resolve } from "path";
 import { fileURLToPath } from "url";
 import themepkg from "../packages/vitepress-theme-async/package.json" assert { type: "json" };
 import clipkg from "../packages/create-theme/package.json" assert { type: "json" };
+import mcppkg from "../packages/mcp-server/package.json" assert { type: "json" };
 
 
 if (process.env.RELEASE_VERSION) {
 	const version = process.env.RELEASE_VERSION.split("/").reverse()[0];
 	console.log("当前版本：", version);
 	themepkg.version = version.replace("v", "");
 	clipkg.version = version.replace("cli-v", "");
+	mcppkg.version = version.replace("mcp-v", "");
 	writeFileSync(resolve(fileURLToPath(import.meta.url), "../../packages/vitepress-theme-async/package.json"), JSON.stringify(themepkg, null, 4), "utf-8");
 	writeFileSync(resolve(fileURLToPath(import.meta.url), "../../packages/create-theme/package.json"), JSON.stringify(clipkg, null, 4), "utf-8");
+	writeFileSync(resolve(fileURLToPath(import.meta.url), "../../packages/mcp-server/package.json"), JSON.stringify(mcppkg, null, 4), "utf-8");
 }