Typescript Prompt Development

🚀 TypeScript 項目提示

本項目是一個使用 TypeScript 編寫的 MCP（模型上下文協議）服務器項目，它提供了多個提示模板，可用於生成與 TypeScript 開發相關的計劃和配置，為 TypeScript 開發帶來便利。

🚀 快速開始

環境配置

.env.development

NODE_ENV=development
PORT=3000

.env.production

NODE_ENV=production
PORT=80

命令行工具

• npm run dev: 啟動開發服務器。
• npm run build: 構建生產版本。
• npm run test: 運行測試用例。

⚠️ 重要提示

使用前請確保安裝所有依賴項，並仔細閱讀相關文檔。

✨ 主要特性

• 提供多個提示模板，可生成與 TypeScript 開發相關的計劃和配置。
• 提示模板參數通過 zod 進行驗證，確保輸入的正確性。
• 提示模板返回格式化的消息，指導 AI 助手生成全面的計劃。

📦 安裝指南

暫未提供安裝步驟相關內容。

💻 使用示例

基礎用法

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']
  }
});

📚 詳細文檔

項目結構

src/

• index.ts: 項目入口點，負責啟動 MCP 服務器。
• prompts/: 提示定義目錄
  • apiArchitecture.ts: 定義 API 架構提示模板。
  • githubWorkflow.ts: 定義 GitHub 工作流提示模板。
  • newProjectSetup.ts: 定義新項目設置提示模板。
  • index.ts: 導出所有提示模板。

scripts/

• prepare-build.ts: 用於準備生產構建的腳本。
• run-relevant-tests.ts: 根據更改文件運行相關測試的腳本。
• setup-husky.js: 設置 Git 鉤子的腳本。

功能說明

提供的提示模板

api-architecture

生成一個全面的 TypeScript API 架構計劃。

參數：

• projectName: API 項目的名稱
• database: 所選數據庫（postgres, mysql, mongodb 等）
• auth: 身份驗證方法（jwt, oauth, none）
• endpoints: 主要 API 端點列表，以逗號分隔

new-project-setup

生成一個全面的新 TypeScript 項目設置計劃。

參數：

• projectName: 項目名稱
• projectType: 項目類型（api, frontend, library, cli）
• features: 關鍵功能或需求，以逗號分隔

github-workflow

生成一個 TypeScript 項目的 GitHub 工作流計劃。

參數：

• projectName: 項目名稱
• ciFeatures: CI 功能列表（lint, test, build 等），以逗號分隔
• deployTarget: 部署目標（netlify, vercel, aws, azure 等）
• branchStrategy: 分支策略（gitflow, trunk, github-flow）

工作原理

1. 服務器使用 MCP SDK 創建一個 MCP 服務器。
2. 每個提示模板定義了結構化的提示內容和參數。
3. 參數通過 zod 進行驗證，確保輸入的正確性。
4. 提示模板返回格式化的消息，指導 AI 助手生成全面的計劃。

開發指南

添加新提示模板

1. 在 src/prompts/ 目錄下創建新的文件。
2. 使用 mcpServer.prompt() 方法定義提示內容。
3. 使用 zod 進行參數驗證。
4. 導出新提示模板到 src/prompts/index.ts。

🔧 技術細節

暫未提供技術細節相關內容。

📄 許可證

本項目使用 MIT 許可證，具體許可內容請參閱 LICENSE 文件。