项目 TypeScript 提示

项目描述

这是一个使用 TypeScript 编写的 MCP（模型上下文协议）服务器项目，提供了多个提示模板，用于生成与 TypeScript 开发相关的计划和配置。以下是项目的完整说明。

项目结构

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。

示例代码

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

环境配置

.env.development

NODE_ENV=development
PORT=3000

.env.production

NODE_ENV=production
PORT=80

命令行工具

• npm run dev: 启动开发服务器。
• npm run build: 构建生产版本。
• npm run test: 运行测试用例。

许可证

本项目使用 MIT 许可证，具体许可内容请参阅 LICENSE 文件。

注意： 使用前请确保安装所有依赖项，并仔细阅读相关文档。