ring-skills-mcp 1.0.5 → 1.0.7

package/README.md

@@ -5,7 +5,7 @@ An MCP (Model Context Protocol) service for fetching and installing company Skil
 ## Features
 
 - **list_skills** - Fetch company Skills list, supports search and pagination
-- **install_skill** - Install skill to local project by skill name
+- **install_skill** - Install skill to local project by gitUrl (supports GitHub and GitLab)
 
 ## Installation
 
@@ -20,8 +20,7 @@ npm run build
 
 | Variable | Description | Default |
 |----------|-------------|---------|
-| `SKILLS_API_HOST` | API server address | `SKILLS_API_HOST` |
-| `SKILLS_REPO` | Skills repository path | `anthropics/skills` |
+| `SKILLS_API_HOST` | API server address | None |
 | `SKILLS_AUTH_TOKEN` | API authentication token (required) | None |
 
 ## Usage in Cursor
@@ -38,7 +37,6 @@ Add the following MCP configuration in Cursor settings:
       "args": ["ring-skills-mcp@latest"],
       "env": {
         "SKILLS_API_HOST": "http://your-api-host:8000",
-        "SKILLS_REPO": "your-org/skills-repo",
         "SKILLS_AUTH_TOKEN": "your-auth-token-here"
       }
     }
@@ -55,8 +53,7 @@ Add the following MCP configuration in Cursor settings:
       "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_API_HOST": "http://your-api-host:8000",
         "SKILLS_AUTH_TOKEN": "your-auth-token-here"
       }
     }
@@ -73,8 +70,7 @@ Add the following MCP configuration in Cursor settings:
       "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_API_HOST": "http://your-api-host:8000",
         "SKILLS_AUTH_TOKEN": "your-auth-token-here"
       }
     }
@@ -102,17 +98,33 @@ Search for skills containing "pdf"
 
 ### install_skill
 
-Install the specified skill to local project.
+Install the specified skill to local project by gitUrl.
 
 **Parameters:**
-- `skillName` (required): Name of the skill to install
+- `gitUrl` (required): Git URL of the skill. Supports both GitHub and GitLab URLs.
 - `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
+- `targetDir` (optional): Installation target directory, default is `.claude/skills`
+
+**Supported URL Formats:**
+
+| Platform | URL Format | Installation Method |
+|----------|------------|---------------------|
+| GitHub | `https://github.com/{owner}/{repo}/tree/{branch}/{path}` | `npx degit` (fast, no git history) |
+| GitLab | `https://{host}/{owner}/{repo}/-/tree/{branch}/{path}` | `git sparse-checkout` (supports private repos) |
+
+**Example URLs:**
+```
+# GitHub
+https://github.com/anthropics/skills/tree/main/skills/docx
+
+# GitLab (self-hosted)
+https://git.ringcentral.com/ai-testing/aiter-skills/-/tree/main/.agent/skills/nova-scripts-generator
+```
 
 **Example usage:**
 ```
-Install pdf skill to /Users/xxx/my-project project
+Install skill from GitHub URL to /Users/xxx/my-project
+Install skill from GitLab URL to /Users/xxx/my-project
 ```
 
 ## Development

package/dist/index.js

@@ -8,7 +8,6 @@ import path from "path";
 const execAsync = promisify(exec);
 // Configuration
 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 || "";
 // Create MCP server
 const server = new McpServer({
@@ -99,18 +98,43 @@ function parseGitUrl(gitUrl) {
     return null;
 }
 /**
- * Build degit source path from git URL info
+ * Install Skill from GitHub using degit
  */
-function buildDegitSource(urlInfo) {
-    if (urlInfo.type === "github") {
-        // GitHub: owner/repo/path#branch
-        return `${urlInfo.owner}/${urlInfo.repo}/${urlInfo.skillPath}#${urlInfo.branch}`;
-    }
-    else if (urlInfo.type === "gitlab") {
-        // GitLab (self-hosted): host:owner/repo/path#branch
-        return `${urlInfo.host}:${urlInfo.owner}/${urlInfo.repo}/${urlInfo.skillPath}#${urlInfo.branch}`;
-    }
-    return "";
+async function installFromGitHub(urlInfo, destPath) {
+    // GitHub: owner/repo/path#branch
+    const sourcePath = `${urlInfo.owner}/${urlInfo.repo}/${urlInfo.skillPath}#${urlInfo.branch}`;
+    const command = `npx degit ${sourcePath} ${destPath}`;
+    const { stdout, stderr } = await execAsync(command);
+    const output = stdout || stderr || "Installation completed";
+    return `✅ Skill "${urlInfo.skillName}" has been successfully installed to ${destPath}\n\nSource: ${sourcePath}\n${output}`;
+}
+/**
+ * Install Skill from GitLab using git sparse-checkout
+ * For private GitLab repositories that degit doesn't support
+ */
+async function installFromGitLab(urlInfo, destPath) {
+    const skillsDir = path.dirname(destPath);
+    const tempDir = `temp-${urlInfo.skillName}-${Date.now()}`;
+    const repoUrl = `https://${urlInfo.host}/${urlInfo.owner}/${urlInfo.repo}.git`;
+    // Build command sequence:
+    // 1. Create target directory
+    // 2. Clone with sparse checkout
+    // 3. Set sparse-checkout path
+    // 4. Move skill folder to destination
+    // 5. Cleanup temp directory
+    const commands = [
+        `mkdir -p ${skillsDir}`,
+        `cd ${skillsDir}`,
+        `git clone --depth 1 --filter=blob:none --sparse ${repoUrl} ${tempDir}`,
+        `cd ${tempDir}`,
+        `git sparse-checkout set ${urlInfo.skillPath}`,
+        `cd ..`,
+        `mv ${tempDir}/${urlInfo.skillPath} ${urlInfo.skillName}`,
+        `rm -rf ${tempDir}`,
+    ].join(" && ");
+    const { stdout, stderr } = await execAsync(commands);
+    const output = stdout || stderr || "Installation completed";
+    return `✅ Skill "${urlInfo.skillName}" has been successfully installed to ${destPath}\n\nSource: ${repoUrl} (${urlInfo.skillPath})\n${output}`;
 }
 /**
  * Install Skill to specified project using gitUrl
@@ -122,38 +146,18 @@ async function installSkillFromGitUrl(gitUrl, projectPath, targetDir = ".claude/
     }
     const skillName = urlInfo.skillName;
     const destPath = path.join(projectPath, targetDir, skillName);
-    const sourcePath = buildDegitSource(urlInfo);
-    if (!sourcePath) {
-        throw new Error(`Could not build degit source from URL: ${gitUrl}`);
-    }
-    const command = `npx degit ${sourcePath} ${destPath}`;
     try {
-        const { stdout, stderr } = await execAsync(command);
-        const output = stdout || stderr || "Installation completed";
-        return `✅ Skill "${skillName}" has been successfully installed to ${destPath}\n\nSource: ${sourcePath}\n${output}`;
-    }
-    catch (error) {
-        if (error instanceof Error) {
-            throw new Error(`Failed to install Skill: ${error.message}`);
+        if (urlInfo.type === "github") {
+            // Use degit for GitHub (faster, no git history)
+            return await installFromGitHub(urlInfo, destPath);
+        }
+        else if (urlInfo.type === "gitlab") {
+            // Use git sparse-checkout for GitLab (supports private repos)
+            return await installFromGitLab(urlInfo, destPath);
+        }
+        else {
+            throw new Error(`Unsupported git URL type: ${gitUrl}`);
         }
-        throw new Error("Failed to install Skill: Unknown error");
-    }
-}
-/**
- * Install Skill to specified project using skill name and repo
- */
-async function installSkillFromRepo(skillName, projectPath, targetDir = ".claude/skills", repo = DEFAULT_SKILLS_REPO) {
-    // Convert skill name to lowercase
-    const normalizedName = skillName.toLowerCase();
-    // Build full installation path
-    const destPath = path.join(projectPath, targetDir, normalizedName);
-    // Build degit command
-    const sourcePath = `${repo}/skills/${normalizedName}`;
-    const command = `npx degit ${sourcePath} ${destPath}`;
-    try {
-        const { stdout, stderr } = await execAsync(command);
-        const output = stdout || stderr || "Installation completed";
-        return `✅ Skill "${normalizedName}" has been successfully installed to ${destPath}\n${output}`;
     }
     catch (error) {
         if (error instanceof Error) {
@@ -232,9 +236,8 @@ server.tool("list_skills", "Fetch company Skills list. You can search for specif
     }
 });
 // Register tool: Install Skill
-server.tool("install_skill", "Install skill to local project by skill name or gitUrl. Uses npx degit to download skill template from remote repository. Project path is required, which can be the project path of the currently opened file in IDE.", {
-    skillName: z.string().optional().describe("Name of the skill to install (e.g., 'webapp-testing'). Either skillName or gitUrl must be provided."),
-    gitUrl: z.string().optional().describe("Git URL of the skill (e.g., 'https://github.com/anthropics/skills/tree/main/skills/webapp-testing'). The skill name will be extracted from this URL. Either skillName or gitUrl must be provided."),
+server.tool("install_skill", "Install skill to local project by gitUrl. Uses npx degit for GitHub repositories and git sparse-checkout for GitLab repositories. Project path is required, which can be the project path of the currently opened file in IDE.", {
+    gitUrl: z.string().describe("Git URL of the skill (e.g., 'https://github.com/anthropics/skills/tree/main/skills/webapp-testing'). The skill name will be extracted from this URL."),
     projectPath: z
         .string()
         .optional()
@@ -243,11 +246,7 @@ server.tool("install_skill", "Install skill to local project by skill name or gi
         .string()
         .optional()
         .describe("Installation target directory, default: .claude/skills"),
-    repo: z
-        .string()
-        .optional()
-        .describe(`Skills repository path, default: ${DEFAULT_SKILLS_REPO}`),
-}, async ({ skillName, gitUrl, projectPath, targetDir, repo }) => {
+}, async ({ gitUrl, projectPath, targetDir }) => {
     // Check if project path is provided
     if (!projectPath) {
         return {
@@ -260,63 +259,23 @@ server.tool("install_skill", "Install skill to local project by skill name or gi
             isError: true,
         };
     }
-    // Priority: gitUrl > skillName
-    if (gitUrl) {
-        // Install from gitUrl (supports GitHub and GitLab)
-        try {
-            const result = await installSkillFromGitUrl(gitUrl, projectPath, targetDir || ".claude/skills");
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: result,
-                    },
-                ],
-            };
-        }
-        catch (error) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `❌ Error: ${error instanceof Error ? error.message : "Unknown error"}`,
-                    },
-                ],
-                isError: true,
-            };
-        }
-    }
-    else if (skillName) {
-        // Install from repo using skill name
-        try {
-            const result = await installSkillFromRepo(skillName, projectPath, targetDir || ".claude/skills", repo || DEFAULT_SKILLS_REPO);
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: result,
-                    },
-                ],
-            };
-        }
-        catch (error) {
-            return {
-                content: [
-                    {
-                        type: "text",
-                        text: `❌ Error: ${error instanceof Error ? error.message : "Unknown error"}`,
-                    },
-                ],
-                isError: true,
-            };
-        }
+    try {
+        const result = await installSkillFromGitUrl(gitUrl, projectPath, targetDir || ".claude/skills");
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: result,
+                },
+            ],
+        };
     }
-    else {
+    catch (error) {
         return {
             content: [
                 {
                     type: "text",
-                    text: "❌ Error: Either skillName or gitUrl must be provided.",
+                    text: `❌ Error: ${error instanceof Error ? error.message : "Unknown error"}`,
                 },
             ],
             isError: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-skills-mcp",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "MCP service for fetching and installing company Skills",
   "type": "module",
   "main": "dist/index.js",