nvidia-nim-mcp: Instructions file for Codex

AGENTS.md

This document provides essential information for agentic coding systems working with this NVIDIA NIM MCP Server codebase.

Build Commands

# Clean build artifacts
npm run clean

# Build TypeScript to JavaScript
npm run build

# Development mode (watch and restart)
npm run dev

# Production start
npm start

Linting Commands

# Run ESLint on source files
npm run lint

Test Commands

# Run all tests
npm test

# Run a specific test file
npm test src/config.test.ts

# Run tests with verbose output
npm test -- --verbose

# Run tests matching a pattern
npm test -- --testNamePattern="Config"

# Run tests in watch mode
npm test -- --watch

# Generate coverage report
npm test -- --coverage

Code Style Guidelines

Imports

• Use ES modules with .js extensions even in TypeScript files
• Import ordering: external packages, internal modules, type-only imports
• Use named imports over default imports when possible
• Group imports logically with blank lines between groups

Formatting

• TypeScript strict mode enabled
• Prettier-style formatting (via ESLint)
• 2-space indentation
• Line width: 80 characters
• Trailing commas in multi-line objects/arrays
• No semicolons (recommended by modern TypeScript)

Types

• Prefer interfaces over types for object shapes
• Use Zod for runtime validation of external inputs
• Explicit typing for function parameters and return values
• Strict null checking enabled
• Avoid any type except in rare justified cases

Naming Conventions

• camelCase for variables and functions
• PascalCase for classes, interfaces, and types
• UPPER_CASE for constants
• Descriptive names over abbreviations
• Boolean variables prefixed with is, has, should, etc.

Error Handling

• Use typed errors and proper error hierarchies
• Always handle promise rejections
• Centralized error logging with winston
• User-friendly error messages for clients
• Preserve stack traces during error wrapping