A Model Context Protocol (MCP) server for managing engineering standards, practices, and processes. This server provides AI assistants with structured access to your organization's engineering knowledge base through a standardized interface.
- Features
- Installation
- Usage
- Architecture
- Tools
- File Naming Conventions
- Configuration
- Contributing
- License
- Multi-dimensional Organization: Standards organized by type, tier, process, and tags
- Full-Text Search: Powerful search with relevance scoring across all standards
- Flexible Output: Support for both JSON and Markdown response formats
- In-Memory Caching: High-performance indexing for fast retrieval
- Type-Safe: Complete TypeScript implementation with strict validation
- MCP-Compliant: Built on the Model Context Protocol SDK v1.24+
- REST API: HTTP transport for easy integration with AI assistants
- CRUD Operations: Create, read, update, and manage standards programmatically
- Node.js >= 18.0.0
- npm (comes with Node.js)
- Clone or extract the project:
cd engineering-standards-mcp-server- Install dependencies:
npm installThis will install approximately 192 packages including:
@modelcontextprotocol/sdk- MCP SDKexpress- HTTP serverzod- Schema validationgray-matter- Markdown frontmatter parsingglob- File pattern matching
- Verify installation:
npm startExpected output:
============================================================
engineering-standards-mcp-server v1.0.0
============================================================
✓ Server running on http://localhost:3000/mcp
✓ Health check: http://localhost:3000/health
Ready to accept MCP connections.
Development mode (with auto-reload):
npm run devProduction mode:
npm startUsing Docker Compose (Recommended):
docker-compose up -dUsing Docker CLI:
# Build the image
npm run docker:build
# Run the container
npm run docker:runFor detailed Docker deployment instructions, see DOCKER.md.
Claude Desktop:
claude mcp add --transport http engineering-standards http://localhost:3000/mcpMCP Inspector (for testing):
npx @modelcontextprotocol/inspector
# Connect to: http://localhost:3000/mcpVS Code (if supported):
code --add-mcp '{"name":"engineering-standards","type":"http","url":"http://localhost:3000/mcp"}'Once connected, you can interact with the server through your AI assistant:
- "List all active backend standards"
- "Search for Spring Boot security practices"
- "Show me the frontend development principles"
- "Create a new standard for API testing"
- "Update the database performance standard"
Verify the server is running:
Invoke-WebRequest -Uri http://localhost:3000/healthengineering-standards-mcp-server/
├── src/
│ ├── index.ts # Main server entry point
│ ├── constants.ts # Configuration constants
│ ├── types.ts # TypeScript type definitions
│ ├── schemas/
│ │ └── metadata.ts # Zod validation schemas
│ ├── services/
│ │ ├── validator.ts # Metadata validation
│ │ ├── parser.ts # Markdown parsing
│ │ ├── storage.ts # File system operations
│ │ └── indexer.ts # In-memory indexing
│ └── tools/
│ ├── list.ts # List index tool
│ ├── get.ts # Get standard tool
│ ├── search.ts # Search tool
│ ├── metadata.ts # Metadata tool
│ ├── create.ts # Create tool
│ └── update.ts # Update tool
├── data/ # Knowledge base directory
├── scripts/
│ └── migrate-standards.ts # Migration utility
├── package.json
├── tsconfig.json
└── README.md
- Validator Service: Validates standard metadata using Zod schemas
- Parser Service: Parses Markdown files with frontmatter
- Storage Service: Manages file system operations
- Indexer Service: Maintains in-memory search index
The server exposes 6 MCP tools following VS Code best practices:
Browse all standards organized hierarchically by type, tier, and process.
Parameters: filterType, filterTier, filterProcess, filterStatus Output: JSON or Markdown
Retrieve a specific standard by its file path or metadata.
Input: File path or metadata combination (type, tier, process) Output: Full standard content with metadata
Full-text search across all standards with relevance scoring.
Input: Query string, optional filters (filterType, filterTier, etc.), limit Output: Ranked search results
Query metadata only without fetching full content.
Parameters: filterType, filterTier, filterProcess, filterStatus, filterTags
Create a new standard with automatic validation and file naming.
Input: Metadata and content Output: Created standard path
Update existing standards with version bumping.
Input: Path, updated content, versionBump type Output: Updated standard details
Standards must follow the naming pattern:
{type}-{tier}-{process}-{slug}-{status}.md
- type:
principle|standard|practice|tech-stack|process - tier:
frontend|backend|database|infrastructure|security - process:
development|testing|delivery|operations - slug: Descriptive kebab-case identifier
- status:
active|draft|deprecated
standard-backend-development-spring-boot-security-active.md
principle-frontend-development-nextjs-principles-active.md
practice-security-testing-penetration-testing-active.md
Customize server behavior with environment variables:
# Change server port (default: 3000)
$env:PORT=3001; npm start
# Change standards directory (default: ./standards)
$env:STANDARDS_DIR="C:\path\to\standards"; npm startThe project uses strict TypeScript settings defined in tsconfig.json:
- ES2022 target
- ESM modules
- Strict type checking enabled
- Source maps for debugging
We welcome contributions to improve the Engineering Standards MCP Server!
-
Fork the repository
-
Create a feature branch:
git checkout -b feature/your-feature-name
-
Make your changes with proper type annotations
-
Test your changes:
npm start # Verify all tools work correctly -
Commit your changes:
git add . git commit -m "Add: your feature description"
-
Push to your fork:
git push origin feature/your-feature-name
-
Open a Pull Request with a clear description of changes
- Follow existing code style and TypeScript patterns
- Add Zod schemas for new validation requirements
- Update tool descriptions when modifying functionality
- Test with MCP Inspector before submitting
- Keep service layers decoupled and focused
- Create tool file in
src/tools/ - Define input schema in
src/schemas/metadata.ts - Register tool in
src/index.ts - Update constants in
src/constants.ts - Add documentation to this README
This project is licensed under the MIT License.
Permission is granted to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to including the copyright notice and permission notice in all copies.
See the full license text: MIT License
New York Life - Technology Division
- Lines of Code: ~3,000+
- Services: 4 core service layers
- Tools: 6 MCP-compliant tools
- Type Definitions: 12 TypeScript interfaces
- Validation Schemas: 7 Zod schemas
- Dependencies: 192 packages (0 vulnerabilities)
- Sample Standards: 2 complete examples included
- Quick Start Guide - Detailed setup and usage instructions
- Model Context Protocol - Official MCP documentation
- MCP SDK - TypeScript SDK repository
For issues, questions, or contributions, please contact the New York Life Technology Division team or open an issue in the repository 2. Follow QUICK_START.md for setup 3. Connect your preferred MCP client 4. Start adding your organization's standards
To migrate legacy standards to the new naming scheme (and normalize type values to singular form), use the migration script:
# Dry-run (preview changes)
npm run migrate
# Apply changes (rename files & update frontmatter)
npm run migrate:applyReady to use! 🚀