parameterized-skill

Parameterized Skill with Examples and Visibility

A skill with customizable parameters, usage examples for AI guidance, and controlled visibility.

Code

// src/skills/api-design-guide.skill.ts
import { Skill, SkillContext } from '@frontmcp/sdk';

@Skill({
  name: 'api-design-guide',
  description: 'REST API design guidelines',
  instructions: `# API Design Guide

Design APIs following these conventions.
Adapt the versioning strategy based on the api-style parameter.
Use the auth-required parameter to determine if authentication sections apply.`,
  parameters: [
    { name: 'api-style', description: 'API style to follow', type: 'string', default: 'rest' },
    { name: 'auth-required', description: 'Whether to include auth guidelines', type: 'boolean', default: true },
    { name: 'version-strategy', description: 'API versioning approach', type: 'string', default: 'url-path' },
  ],
  examples: [
    {
      scenario: 'Adding error handling to a new API endpoint',
      expectedOutcome:
        'Endpoint uses specific error classes with MCP error codes, validates input, and returns structured error responses',
    },
    {
      scenario: 'Refactoring try-catch blocks in existing code',
      expectedOutcome: 'Generic catches replaced with specific error types, proper error propagation chain established',
    },
  ],
  tags: ['api', 'design', 'standards'],
  visibility: 'both',
})
class ApiDesignGuideSkill extends SkillContext {}

// src/skills/internal-runbook.skill.ts
import { Skill, SkillContext } from '@frontmcp/sdk';

@Skill({
  name: 'internal-runbook',
  description: 'Internal operations runbook',
  instructions: `# Operations Runbook

## Incident Response
1. Check monitoring dashboards
2. Identify affected services
3. Escalate if severity is P0 or P1`,
  visibility: 'mcp', // Only visible to MCP clients, not HTTP discovery
})
class InternalRunbookSkill extends SkillContext {}

// src/skills/admin-procedures.skill.ts
import { Skill, SkillContext } from '@frontmcp/sdk';

@Skill({
  name: 'admin-procedures',
  description: 'Administrative procedures for internal use',
  instructions: '...',
  hideFromDiscovery: true, // Registered but hidden from listing endpoints
})
class AdminProceduresSkill extends SkillContext {}