Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | 57x 57x 57x 57x 57x 57x 57x 57x 22x 22x 22x 22x 22x 22x 22x 2x 20x 22x 2x 20x 57x 57x 57x 57x | /**
* Profile types and Zod schemas for GitLab MCP configuration profiles
*
* Profiles enable:
* - Multi-GitLab instance support
* - Role-based access patterns
* - Feature flag presets
* - Tool restrictions
*/
import { z } from "zod";
// ============================================================================
// Authentication Schemas
// ============================================================================
const PatAuthSchema = z.object({
type: z.literal("pat"),
token_env: z.string().describe("Environment variable containing the PAT token"),
});
const OAuthAuthSchema = z.object({
type: z.literal("oauth"),
client_id_env: z.string().describe("Environment variable containing OAuth client ID"),
client_secret_env: z
.string()
.optional()
.describe("Environment variable containing OAuth client secret"),
});
const CookieAuthSchema = z.object({
type: z.literal("cookie"),
cookie_path: z.string().describe("Path to cookie file for authentication"),
});
const AuthConfigSchema = z.discriminatedUnion("type", [
PatAuthSchema,
OAuthAuthSchema,
CookieAuthSchema,
]);
// ============================================================================
// Feature Flags Schema
// ============================================================================
const FeatureFlagsSchema = z
.object({
wiki: z.boolean().optional(),
milestones: z.boolean().optional(),
pipelines: z.boolean().optional(),
labels: z.boolean().optional(),
mrs: z.boolean().optional(),
files: z.boolean().optional(),
variables: z.boolean().optional(),
workitems: z.boolean().optional(),
webhooks: z.boolean().optional(),
snippets: z.boolean().optional(),
integrations: z.boolean().optional(),
// New entities (#78, #81, #82, #83)
releases: z.boolean().optional(),
refs: z.boolean().optional(),
members: z.boolean().optional(),
search: z.boolean().optional(),
})
.optional();
// ============================================================================
// Profile Schema
// ============================================================================
/**
* Full profile schema - for user-defined profiles with complete configuration
*/
export const ProfileSchema = z.object({
// Connection (required for user profiles)
host: z.string().describe("GitLab hostname (e.g., gitlab.company.com)"),
api_url: z.string().url().optional().describe("Override API URL (default: https://{host})"),
// Authentication (required for user profiles)
auth: AuthConfigSchema,
// Access Control
read_only: z.boolean().optional().describe("Enable read-only mode"),
allowed_projects: z
.array(z.string())
.optional()
.describe("Project whitelist (empty = all allowed)"),
allowed_groups: z.array(z.string()).optional().describe("Group whitelist (empty = all allowed)"),
denied_tools_regex: z.string().optional().describe("Regex pattern to exclude tools"),
allowed_tools: z
.array(z.string())
.optional()
.describe("Explicit tool whitelist (overrides denied_tools_regex)"),
denied_actions: z.array(z.string()).optional().describe("Denied actions in format 'tool:action'"),
// Feature Flags
features: FeatureFlagsSchema,
// Behavior
timeout_ms: z.number().int().positive().optional().describe("API timeout in milliseconds"),
default_project: z.string().optional().describe("Auto-set project context"),
default_namespace: z.string().optional().describe("Auto-set namespace context"),
// TLS Configuration
skip_tls_verify: z.boolean().optional().describe("Skip TLS certificate verification"),
ssl_cert_path: z.string().optional().describe("Path to SSL certificate"),
ssl_key_path: z.string().optional().describe("Path to SSL key"),
ca_cert_path: z.string().optional().describe("Path to CA certificate"),
});
// ============================================================================
// Scope Config Schema (used by both Preset and ProjectPreset)
// ============================================================================
/**
* Scope configuration for project-level and group-level restrictions.
* Determines which projects/namespaces/groups operations are allowed on.
*/
export const ScopeConfigSchema = z
.object({
/** Single project restriction */
project: z.string().optional().describe("Single project path (e.g., group/project)"),
/** Single group restriction */
group: z.string().optional().describe("Single group path (e.g., my-group or parent/child)"),
/** Namespace restriction (all projects in group) */
namespace: z.string().optional().describe("Namespace/group path"),
/** Explicit list of allowed projects */
projects: z.array(z.string()).optional().describe("List of allowed project paths"),
/** Explicit list of allowed groups */
groups: z.array(z.string()).optional().describe("List of allowed group paths"),
/** Include subgroups in group scope (default: true when undefined) */
includeSubgroups: z
.boolean()
.optional()
.describe("Include subgroups when group scope is set (default: true)"),
})
.refine(
data => {
// At least one scope field must be set
const hasProject = data.project !== undefined;
const hasGroup = data.group !== undefined;
const hasNamespace = data.namespace !== undefined;
const hasProjects = data.projects !== undefined && data.projects.length > 0;
const hasGroups = data.groups !== undefined && data.groups.length > 0;
return hasProject || hasGroup || hasNamespace || hasProjects || hasGroups;
},
{ message: "Scope must define at least one of: project, group, namespace, projects, or groups" }
)
.refine(
data => {
// Cannot combine project with projects
if (data.project && data.projects && data.projects.length > 0) {
return false;
}
return true;
},
{ message: "Cannot combine 'project' with 'projects' - use one or the other" }
)
.refine(
data => {
// Cannot combine group with groups
if (data.group && data.groups && data.groups.length > 0) {
return false;
}
return true;
},
{ message: "Cannot combine 'group' with 'groups' - use one or the other" }
);
// ============================================================================
// Preset Schema (for built-in profiles - NO host/auth, only settings)
// ============================================================================
/**
* Preset schema - for built-in profiles that only define settings/restrictions
* These are applied ON TOP of existing environment configuration.
* They NEVER contain host or auth - those come from env vars or user profiles.
*/
export const PresetSchema = z
.object({
// Description for documentation
description: z.string().optional().describe("Human-readable description of the preset"),
// Access Control
read_only: z.boolean().optional().describe("Enable read-only mode"),
denied_tools_regex: z.string().optional().describe("Regex pattern to exclude tools"),
allowed_tools: z.array(z.string()).optional().describe("Explicit tool whitelist"),
denied_actions: z
.array(z.string())
.optional()
.describe("Denied actions in format 'tool:action'"),
// Scope restrictions (can be set at runtime via manage_context)
scope: ScopeConfigSchema.optional().describe("Runtime scope restrictions for projects/groups"),
// Feature Flags
features: FeatureFlagsSchema,
// Behavior
timeout_ms: z.number().int().positive().optional().describe("API timeout in milliseconds"),
})
.strict(); // Reject unknown fields like host/auth for security
// ============================================================================
// Profiles Config File Schema
// ============================================================================
export const ProfilesConfigSchema = z.object({
profiles: z.record(z.string(), ProfileSchema).describe("Named profiles"),
default_profile: z.string().optional().describe("Default profile when none specified"),
});
// ============================================================================
// Project-Level Configuration Schemas (.gitlab-mcp/)
// ============================================================================
/**
* Project-level preset schema (.gitlab-mcp/preset.yaml)
* Defines restrictions specific to this project repository.
* These are applied ON TOP of user profiles/presets.
*/
export const ProjectPresetSchema = z
.object({
/** Human-readable description */
description: z.string().optional().describe("Description of project restrictions"),
/** Scope restriction - limits operations to specific projects/namespaces */
scope: ScopeConfigSchema.optional().describe("Project/namespace scope restrictions"),
/** Feature restrictions */
features: FeatureFlagsSchema,
/** Denied actions in format 'tool:action' */
denied_actions: z
.array(z.string())
.optional()
.describe("Denied actions in format 'tool:action'"),
/** Denied tools (by name) */
denied_tools: z.array(z.string()).optional().describe("List of denied tool names"),
/** Enable read-only mode for this project */
read_only: z.boolean().optional().describe("Enable read-only mode"),
})
.strict();
/**
* Project-level profile schema (.gitlab-mcp/profile.yaml)
* Defines tool selection and feature configuration for this project.
* Can extend a built-in preset.
*/
export const ProjectProfileSchema = z
.object({
/** Human-readable description */
description: z.string().optional().describe("Description of project configuration"),
/** Inherit from a built-in preset */
extends: z.string().optional().describe("Built-in preset name to inherit from"),
/** Feature overrides (applied after extends) */
features: FeatureFlagsSchema,
/** Additional tools beyond base preset */
additional_tools: z.array(z.string()).optional().describe("Additional tools to enable"),
/** Tools to remove from base preset */
denied_tools: z.array(z.string()).optional().describe("Tools to disable"),
})
.strict();
/**
* Combined project configuration loaded from .gitlab-mcp/ directory
*/
export interface ProjectConfig {
/** Path to the .gitlab-mcp/ directory */
configPath: string;
/** Preset from preset.yaml (restrictions) */
preset?: ProjectPreset;
/** Profile from profile.yaml (tool selection) */
profile?: ProjectProfile;
}
// ============================================================================
// TypeScript Types (inferred from schemas)
// ============================================================================
export type PatAuth = z.infer<typeof PatAuthSchema>;
export type OAuthAuth = z.infer<typeof OAuthAuthSchema>;
export type CookieAuth = z.infer<typeof CookieAuthSchema>;
export type AuthConfig = z.infer<typeof AuthConfigSchema>;
export type FeatureFlags = z.infer<typeof FeatureFlagsSchema>;
export type ScopeConfig = z.infer<typeof ScopeConfigSchema>;
export type Profile = z.infer<typeof ProfileSchema>;
export type Preset = z.infer<typeof PresetSchema>;
export type ProfilesConfig = z.infer<typeof ProfilesConfigSchema>;
export type ProjectPreset = z.infer<typeof ProjectPresetSchema>;
export type ProjectProfile = z.infer<typeof ProjectProfileSchema>;
// ============================================================================
// Profile Info (for listing)
// ============================================================================
export interface ProfileInfo {
name: string;
host?: string; // Optional - presets don't have host
authType?: "pat" | "oauth" | "cookie"; // Optional - presets don't have auth
readOnly: boolean;
isBuiltIn: boolean;
isPreset: boolean; // true for built-in presets, false for full profiles
description?: string;
}
// ============================================================================
// Validation Result
// ============================================================================
export interface ProfileValidationResult {
valid: boolean;
errors: string[];
warnings: string[];
}
|