Typescript Prompt Development

🚀 TypeScript Prompt Project

This is a TypeScript-based MCP (Model Context Protocol) server project that offers multiple prompt templates for generating plans and configurations related to TypeScript development.

🚀 Quick Start

This project is a TypeScript-based MCP server that provides various prompt templates for generating plans and configurations in TypeScript development. Below is a comprehensive guide to the project.

✨ Features

Provided Prompt Templates

api-architecture

Generate a comprehensive TypeScript API architecture plan.

Parameters:

• projectName: Name of the API project
• database: Selected database (postgres, mysql, mongodb, etc.)
• auth: Authentication method (jwt, oauth, none)
• endpoints: List of main API endpoints, separated by commas

new-project-setup

Generate a comprehensive new TypeScript project setup plan.

Parameters:

• projectName: Project name
• projectType: Project type (api, frontend, library, cli)
• features: Key features or requirements, separated by commas

github-workflow

Generate a GitHub workflow plan for a TypeScript project.

Parameters:

• projectName: Project name
• ciFeatures: List of CI features (lint, test, build, etc.), separated by commas
• deployTarget: Deployment target (netlify, vercel, aws, azure, etc.)
• branchStrategy: Branch strategy (gitflow, trunk, github-flow)

📦 Installation

Prerequisites

Ensure you have Node.js and npm installed on your machine.

Steps

1. Clone the repository:

   git clone <repository-url>
   cd <project-directory>
   

2. Install dependencies:

   npm install
   

💻 Usage Examples

Basic Usage

To start the development server:

npm run dev

Advanced Usage

To build the production version:

npm run build

To run tests:

npm run test

📚 Documentation

Project Structure

src/

• index.ts: Entry point of the project, responsible for starting the MCP server.
• prompts/: Directory for prompt definitions
  • apiArchitecture.ts: Defines the API architecture prompt template.
  • githubWorkflow.ts: Defines the GitHub workflow prompt template.
  • newProjectSetup.ts: Defines the new project setup prompt template.
  • index.ts: Exports all prompt templates.

scripts/

• prepare-build.ts: Script for preparing the production build.
• run-relevant-tests.ts: Script for running relevant tests based on changed files.
• setup-husky.js: Script for setting up Git hooks.

How It Works

1. The server uses the MCP SDK to create an MCP server.
2. Each prompt template defines structured prompt content and parameters.
3. Parameters are validated using zod to ensure correct input.
4. The prompt template returns a formatted message to guide the AI assistant to generate a comprehensive plan.

Adding New Prompt Templates

1. Create a new file in the src/prompts/ directory.
2. Use the mcpServer.prompt() method to define the prompt content.
3. Validate parameters using zod.
4. Export the new prompt template to src/prompts/index.ts.

Example Code

import { prompt } from '../prompt';

export const newProjectSetupPrompt = prompt({
  name: 'new-project-setup',
  title: 'New Project Setup',
  description: 'Generate setup instructions for a new TypeScript project.',
  parameters: [
    { name: 'projectName', type: 'string', required: true },
    { name: 'projectType', type: 'string', required: true, options: ['api', 'frontend', 'library', 'cli'] },
    { name: 'features', type: 'string[]', required: false }
  ],
  example: {
    projectName: 'my-ts-app',
    projectType: 'frontend',
    features: ['react', 'typescript', 'axios']
  }
});

Environment Configuration

.env.development

NODE_ENV=development
PORT=3000

.env.production

NODE_ENV=production
PORT=80

🔧 Technical Details

Parameter Validation

The project uses zod to validate parameters in prompt templates. This ensures that the input data meets the expected format and requirements.

MCP Server

The MCP server is created using the MCP SDK. It provides a structured way to handle prompts and interact with AI assistants.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

⚠️ Important Note

Make sure to install all dependencies and read the relevant documentation before use.