ring-skills-mcp 1.3.2 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +78 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,6 +7,8 @@ An MCP (Model Context Protocol) service for fetching and installing company Skil
|
|
|
7
7
|
- **list_skills** - Fetch company Skills and Skill Groups list, supports search and pagination
|
|
8
8
|
- **install_skill** - Install skill to local project by gitUrl (supports GitHub and GitLab)
|
|
9
9
|
- **install_skill_group** - Install all skills from a skill group to local project
|
|
10
|
+
- **check_gitlab_credentials** - Check if GitLab credentials are configured for a host
|
|
11
|
+
- **setup_gitlab_credentials** - Configure GitLab credentials for private repository access
|
|
10
12
|
|
|
11
13
|
## Installation
|
|
12
14
|
|
|
@@ -110,6 +112,8 @@ Install the specified skill to local project by gitUrl.
|
|
|
110
112
|
- `gitUrl` (required): Git URL of the skill. Supports both GitHub and GitLab URLs.
|
|
111
113
|
- `projectPath` (required): Project path where the skill will be installed. Please provide the project root directory path of the currently opened file in IDE
|
|
112
114
|
- `targetDir` (optional): Installation target directory, default is `.claude/skills`
|
|
115
|
+
- `gitToken` (optional): GitLab Personal Access Token for private repository authentication. If provided, will be saved for future use.
|
|
116
|
+
- `saveCredentials` (optional): Whether to save the token for future use. Default: true
|
|
113
117
|
|
|
114
118
|
**Supported URL Formats:**
|
|
115
119
|
|
|
@@ -131,6 +135,7 @@ https://git.ringcentral.com/ai-testing/aiter-skills/-/tree/main/.agent/skills/no
|
|
|
131
135
|
```
|
|
132
136
|
Install skill from GitHub URL to /Users/xxx/my-project
|
|
133
137
|
Install skill from GitLab URL to /Users/xxx/my-project
|
|
138
|
+
Install skill from private GitLab with token: gitToken=glpat-xxxx
|
|
134
139
|
```
|
|
135
140
|
|
|
136
141
|
### install_skill_group
|
|
@@ -143,6 +148,7 @@ Install all skills from a skill group to local project.
|
|
|
143
148
|
- `token` (optional): Authorization token, can be passed as parameter or set via environment variable `SKILLS_AUTH_TOKEN`
|
|
144
149
|
- `projectPath` (required): Project path where the skills will be installed
|
|
145
150
|
- `targetDir` (optional): Installation target directory, default is `.claude/skills`
|
|
151
|
+
- `gitToken` (optional): GitLab Personal Access Token for private repository authentication
|
|
146
152
|
|
|
147
153
|
**Example usage:**
|
|
148
154
|
```
|
|
@@ -154,6 +160,78 @@ Install all skills from skill group "697190fc88f4e586fb1a7114" to /Users/xxx/my-
|
|
|
154
160
|
- Lists all successfully installed skills
|
|
155
161
|
- Reports any installation errors
|
|
156
162
|
|
|
163
|
+
### check_gitlab_credentials
|
|
164
|
+
|
|
165
|
+
Check if GitLab credentials are already configured for a host.
|
|
166
|
+
|
|
167
|
+
**Parameters:**
|
|
168
|
+
- `host` (required): GitLab host domain to check (e.g., 'git.ringcentral.com')
|
|
169
|
+
|
|
170
|
+
**Example usage:**
|
|
171
|
+
```
|
|
172
|
+
check_gitlab_credentials:
|
|
173
|
+
host: git.ringcentral.com
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Returns:**
|
|
177
|
+
- ✅ Credentials configured - if credentials exist
|
|
178
|
+
- ⚠️ No credentials found - if credentials need to be configured
|
|
179
|
+
|
|
180
|
+
### setup_gitlab_credentials
|
|
181
|
+
|
|
182
|
+
Configure GitLab credentials for private repository access. The token will be saved to your system's git credential store.
|
|
183
|
+
|
|
184
|
+
**Parameters:**
|
|
185
|
+
- `host` (required): GitLab host domain (e.g., 'git.ringcentral.com')
|
|
186
|
+
- `token` (required): GitLab Personal Access Token with 'read_repository' scope
|
|
187
|
+
- `force` (optional): Force overwrite even if credentials already exist. Default: false
|
|
188
|
+
|
|
189
|
+
**How to create a Personal Access Token:**
|
|
190
|
+
1. Open `https://{host}/-/user_settings/personal_access_tokens`
|
|
191
|
+
2. Login to your GitLab account
|
|
192
|
+
3. Create a new Token:
|
|
193
|
+
- Token name: `ring-skills-mcp`
|
|
194
|
+
- Expiration: Select a date (recommended: 1 year)
|
|
195
|
+
- Scopes: Check `read_repository`
|
|
196
|
+
4. Click "Create personal access token"
|
|
197
|
+
5. Copy the generated Token
|
|
198
|
+
|
|
199
|
+
**Example usage:**
|
|
200
|
+
```
|
|
201
|
+
setup_gitlab_credentials:
|
|
202
|
+
host: git.ringcentral.com
|
|
203
|
+
token: glpat-xxxxxxxxxxxx
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
## GitLab Private Repository Authentication
|
|
207
|
+
|
|
208
|
+
For private GitLab repositories, you have two options:
|
|
209
|
+
|
|
210
|
+
### Option 1: Pre-configure credentials (Recommended)
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
# First, setup credentials
|
|
214
|
+
setup_gitlab_credentials:
|
|
215
|
+
host: git.ringcentral.com
|
|
216
|
+
token: glpat-xxxxxxxxxxxx
|
|
217
|
+
|
|
218
|
+
# Then install skills without providing token each time
|
|
219
|
+
install_skill:
|
|
220
|
+
gitUrl: https://git.ringcentral.com/...
|
|
221
|
+
projectPath: /path/to/project
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Option 2: Provide token with each installation
|
|
225
|
+
|
|
226
|
+
```
|
|
227
|
+
install_skill:
|
|
228
|
+
gitUrl: https://git.ringcentral.com/...
|
|
229
|
+
projectPath: /path/to/project
|
|
230
|
+
gitToken: glpat-xxxxxxxxxxxx
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
The token will be automatically saved for future use.
|
|
234
|
+
|
|
157
235
|
## Development
|
|
158
236
|
|
|
159
237
|
```bash
|