ring-skills-mcp 1.0.0

package/README.md

@@ -0,0 +1,133 @@
+# Ring Skills MCP Service
+
+An MCP (Model Context Protocol) service for fetching and installing company Skills.
+
+## Features
+
+- **list_skills** - Fetch company Skills list, supports search and pagination
+- **install_skill** - Install skill to local project by skill name
+
+## Installation
+
+```bash
+npm install
+npm run build
+```
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `SKILLS_API_HOST` | API server address | `SKILLS_API_HOST` |
+| `SKILLS_REPO` | Skills repository path | `anthropics/skills` |
+| `SKILLS_AUTH_TOKEN` | API authentication token (required) | None |
+
+## Usage in Cursor
+
+Add the following MCP configuration in Cursor settings:
+
+### Option 1: Run with Node
+
+```json
+{
+  "mcpServers": {
+    "ring-skills-mcp": {
+      "command": "node",
+      "args": ["/path/to/ring-skills-mcp/dist/index.js"],
+      "env": {
+        "SKILLS_API_HOST": "SKILLS_API_HOST",
+        "SKILLS_REPO": "your-org/skills-repo",
+        "SKILLS_AUTH_TOKEN": "your-auth-token-here"
+      }
+    }
+  }
+}
+```
+
+### Option 2: Run with npx (development mode)
+
+```json
+{
+  "mcpServers": {
+    "ring-skills-mcp": {
+      "command": "npx",
+      "args": ["tsx", "/path/to/ring-skills-mcp/src/index.ts"],
+      "env": {
+        "SKILLS_API_HOST": "SKILLS_API_HOST",
+        "SKILLS_REPO": "your-org/skills-repo",
+        "SKILLS_AUTH_TOKEN": "your-auth-token-here"
+      }
+    }
+  }
+}
+```
+
+## Tool Documentation
+
+### list_skills
+
+Fetch company Skills list.
+
+**Parameters:**
+- `host` (optional): API server address
+- `search` (optional): Search keyword
+- `pageSize` (optional): Number of results per page, default 5000
+- `token` (required): Authorization token, can be passed as parameter or set via environment variable `SKILLS_AUTH_TOKEN`
+
+**Example usage:**
+```
+Get all skills list
+Search for skills containing "pdf"
+```
+
+### install_skill
+
+Install the specified skill to local project.
+
+**Parameters:**
+- `skillName` (required): Name of the skill to install
+- `projectPath` (required): Project path where the skill will be installed. Please provide the project root directory path of the currently opened file in IDE
+- `targetDir` (optional): Installation target directory, default is `skills`
+- `repo` (optional): Skills repository path
+
+**Example usage:**
+```
+Install pdf skill to /Users/xxx/my-project project
+```
+
+## Development
+
+```bash
+# Run in development mode
+npm run dev
+
+# Build
+npm run build
+
+# Run built version
+npm start
+```
+
+## API Response Format
+
+The service supports the following API response formats:
+
+```json
+// Format 1: Direct array
+[{ "id": "1", "name": "skill1" }]
+
+// Format 2: data field
+{ "data": [{ "id": "1", "name": "skill1" }] }
+
+// Format 3: skills field
+{ "skills": [{ "id": "1", "name": "skill1" }] }
+
+// Format 4: items field
+{ "items": [{ "id": "1", "name": "skill1" }] }
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,206 @@
+#!/usr/bin/env node
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { z } from "zod";
+import { exec } from "child_process";
+import { promisify } from "util";
+import path from "path";
+const execAsync = promisify(exec);
+// 配置
+const DEFAULT_API_HOST = process.env.SKILLS_API_HOST || "";
+const DEFAULT_SKILLS_REPO = process.env.SKILLS_REPO || "anthropics/skills";
+const DEFAULT_AUTH_TOKEN = process.env.SKILLS_AUTH_TOKEN || "";
+// 创建MCP服务器
+const server = new McpServer({
+    name: "ring-skills-mcp",
+    version: "1.0.0",
+});
+/**
+ * 获取Skills列表
+ */
+async function fetchSkills(host, search = "", pageSize = 5000, token = "") {
+    const url = `${host}/api/skills?search=${encodeURIComponent(search)}&pageSize=${pageSize}`;
+    try {
+        const headers = {};
+        if (token) {
+            headers["Authorization"] = token;
+        }
+        const response = await fetch(url, { headers });
+        if (!response.ok) {
+            throw new Error(`API请求失败: ${response.status} ${response.statusText}`);
+        }
+        const data = (await response.json());
+        // 兼容不同的API返回格式
+        if (Array.isArray(data)) {
+            return data;
+        }
+        if (data.data && Array.isArray(data.data)) {
+            return data.data;
+        }
+        if (data.skills && Array.isArray(data.skills)) {
+            return data.skills;
+        }
+        if (data.items && Array.isArray(data.items)) {
+            return data.items;
+        }
+        return [];
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new Error(`获取Skills列表失败: ${error.message}`);
+        }
+        throw new Error("获取Skills列表失败: 未知错误");
+    }
+}
+/**
+ * 安装Skill到指定项目
+ */
+async function installSkill(skillName, projectPath, targetDir = "skills", repo = DEFAULT_SKILLS_REPO) {
+    // 将skill名称转换为小写
+    const normalizedName = skillName.toLowerCase();
+    // 构建完整安装路径
+    const destPath = path.join(projectPath, targetDir, normalizedName);
+    // 构建degit命令
+    const sourcePath = `${repo}/skills/${normalizedName}`;
+    const command = `npx degit ${sourcePath} ${destPath}`;
+    try {
+        const { stdout, stderr } = await execAsync(command);
+        const output = stdout || stderr || "安装完成";
+        return `✅ Skill "${normalizedName}" 已成功安装到 ${destPath}\n${output}`;
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new Error(`安装Skill失败: ${error.message}`);
+        }
+        throw new Error("安装Skill失败: 未知错误");
+    }
+}
+// 注册工具: 获取Skills列表
+server.tool("list_skills", "获取公司Skills列表。可以通过search参数搜索特定的skill。需要提供Authorization token进行认证。", {
+    host: z
+        .string()
+        .optional()
+        .describe(`API服务器地址，默认: ${DEFAULT_API_HOST}`),
+    search: z.string().optional().describe("搜索关键词，用于过滤skills"),
+    pageSize: z.number().optional().describe("每页返回数量，默认: 5000"),
+    token: z
+        .string()
+        .optional()
+        .describe("Authorization token (必需)，用于API认证。可通过此参数传入或设置环境变量SKILLS_AUTH_TOKEN"),
+}, async ({ host, search, pageSize, token }) => {
+    try {
+        const apiHost = host || DEFAULT_API_HOST;
+        const authToken = token || DEFAULT_AUTH_TOKEN;
+        if (!authToken) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "❌ 错误: 缺少Authorization token。请通过token参数提供，或设置环境变量SKILLS_AUTH_TOKEN。",
+                    },
+                ],
+                isError: true,
+            };
+        }
+        const skills = await fetchSkills(apiHost, search || "", pageSize || 5000, authToken);
+        if (skills.length === 0) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "未找到任何Skills。请检查API地址是否正确或尝试不同的搜索关键词。",
+                    },
+                ],
+            };
+        }
+        // 格式化输出
+        const skillsList = skills
+            .map((skill, index) => {
+            const title = skill.title || skill.id || "未命名";
+            const summary = skill.summary || "无描述";
+            const category = skill.category ? ` [${skill.category}]` : "";
+            return `${index + 1}. **${title}**${category}\n   ${summary}`;
+        })
+            .join("\n\n");
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `## Skills列表 (共 ${skills.length} 个)\n\n${skillsList}`,
+                },
+            ],
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ 错误: ${error instanceof Error ? error.message : "未知错误"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+});
+// 注册工具: 安装Skill
+server.tool("install_skill", "根据skill名称安装skill到本地项目。使用npx degit从远程仓库下载skill模板。需要提供项目路径，可以是当前IDE打开文件所在的项目路径。", {
+    skillName: z.string().describe("要安装的skill名称"),
+    projectPath: z
+        .string()
+        .optional()
+        .describe("项目路径 (必需)，skill将安装到此项目下。请提供当前IDE打开文件所在的项目根目录路径"),
+    targetDir: z
+        .string()
+        .optional()
+        .describe("安装目标目录，默认: skills"),
+    repo: z
+        .string()
+        .optional()
+        .describe(`Skills仓库路径，默认: ${DEFAULT_SKILLS_REPO}`),
+}, async ({ skillName, projectPath, targetDir, repo }) => {
+    // 检查是否提供了项目路径
+    if (!projectPath) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: "❌ 请提供项目路径 (projectPath)。\n\n您可以提供当前IDE打开文件所在的项目根目录路径，skill将安装到该项目的 skills 目录下。\n\n例如: /Users/xxx/my-project",
+                },
+            ],
+            isError: true,
+        };
+    }
+    try {
+        const result = await installSkill(skillName, projectPath, targetDir || "skills", repo || DEFAULT_SKILLS_REPO);
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: result,
+                },
+            ],
+        };
+    }
+    catch (error) {
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: `❌ 错误: ${error instanceof Error ? error.message : "未知错误"}`,
+                },
+            ],
+            isError: true,
+        };
+    }
+});
+// 启动服务器
+async function main() {
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    console.error("Ring Skills MCP服务已启动");
+}
+main().catch((error) => {
+    console.error("服务启动失败:", error);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "ring-skills-mcp",
+  "version": "1.0.0",
+  "description": "MCP service for fetching and installing company Skills",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "ring-skills-mcp": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/index.ts",
+    "start": "node dist/index.js",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "mcp",
+    "skills",
+    "anthropic"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.3"
+  }
+}
+