snyk-mcp-rest: Instructions file for GitHub Copilot

GitHub Copilot Instructions for snyk-mcp-rest

Project Overview

This is an auto-generated TypeScript client for the Snyk REST API built with OpenAPI Generator. The architecture separates generated code (src/generated/) from custom code (src/index.ts), with the entry point re-exporting the generated API classes.

Critical: Generated Code Protection

NEVER edit files in src/generated/ - they are auto-generated from res/snyk-openapi-2025-11-05.json via OpenAPI Generator. NEVER edit res/snyk-openapi-2025-11-05.json.

• Generated code is recreated on every npm run generate
• To fix issues in generated code, modify the OpenAPI spec or openapitools.json config
• Coverage exclusion explicitly ignores src/generated/** (see vitest.config.ts)

Code Generation Workflow

The project uses OpenAPI Generator (typescript-axios template) configured in openapitools.json:

npm run generate  # Regenerates src/generated/ from OpenAPI spec
npm run build     # Compiles TypeScript to dist/
npm run prepare   # Runs both generate + build (used in package lifecycle)

Generator config details:

• Output: ./src/generated
• Template: typescript-axios (Axios-based HTTP client)
• Key options: useSingleRequestParameter: true (all API params in one object)
• Organized into models/ (TypeScript interfaces) and api/ (API classes)

API Usage Patterns

All Snyk API calls require a version parameter (e.g., '2024-11-05'). Authentication uses either apiKey or accessToken:

const config = new Configuration({
  apiKey: process.env.SNYK_API_KEY,
  basePath: 'https://api.snyk.io/rest'
});

const orgsApi = new OrgsApi(config);
const response = await orgsApi.listOrgs({ version: '2024-11-05' });

Key API classes available: OrgsApi, ProjectsApi, IssuesApi, GroupsApi, etc. (see src/generated/api/ for full list).

Testing Requirements

CRITICAL: After making code changes, always follow this workflow:

1. Fix linting and syntax errors first
   • Run TypeScript compiler to check for syntax errors: npx tsc --noEmit
   • Fix all TypeScript compilation errors before proceeding
   • Ensure code passes linting rules
   • Never proceed to testing with compilation errors