TypeScript Prompt MCP 服务器

一个提供预定义提示模板的模型上下文协议（MCP）服务器，允许AI助手为TypeScript项目、API架构和GitHub工作流生成全面的计划。

🌟 概述

此MCP服务器提供了一组可用于AI助手的提示模板，以生成详细的、结构化的响应，用于TypeScript项目规划。它提供了以下模板：

• 创建全面的API架构计划
• 使用最佳实践设置新的TypeScript项目
• 生成GitHub工作流配置

该MCP特别设计用于与本地开发MCP配合使用，形成强大的组合，其中Prompt MCP生成详细的项目计划，而Local Dev MCP执行这些计划。它们共同创建了一个无缝的工作流程，用于AI辅助的TypeScript项目开发。

每个提示模板都旨在确保AI助手遵循现代TypeScript开发标准，提供一致、高质量且详细的项目计划。

🚀 特性

• 🏗️ API架构规划：生成包括层次、文件夹结构和数据库模式在内的全面API架构计划
• 🚀 项目设置：为新的TypeScript项目创建详细的设置计划，包括适当的依赖项和配置
• 🔄 GitHub工作流：设计包含分支策略、PR模板和CI/CD配置的GitHub工作流计划
• 🛠️ 自定义：每个提示接受参数，以根据您的具体需求定制生成的计划
• ⚡ 一致的输出：确保AI助手提供的结构化、详细的响应遵循最佳实践

📋 前提条件

• Node.js (v14或更高版本)
• npm 或 yarn

🔧 安装

1. 克隆仓库

   git clone <repository-url>
   cd typescript-prompt-mcp
   

2. 安装依赖项

   npm install
   

3. 设置环境变量

   # 创建开发环境文件
   cp .env.example .env.development
   # 创建生产环境文件
   cp .env.example .env.production
   

🎮 使用

开发模式

npm run dev

这将以热重载的方式启动开发模式下的MCP服务器。

生产模式

npm run build
npm start

或者使用简写：

npm run prod

🔗 与本地开发MCP和Claude Desktop集成

要将此MCP服务器添加到Claude Desktop中：

1. 启动 MCP 服务器
   确保您的服务器在本地运行。

2. 打开 Claude Desktop 设置

   • 启动 Claude Desktop
   • 点击右上角的个人头像或图标
   • 从下拉菜单中选择“设置”

3. 导航到扩展设置

   • 在设置侧边栏中，点击“扩展”
   • 选择“添加自定义 MCP”

4.1 配置 MCP 连接

• 名称：TypeScript Prompt MCP（或您喜欢的任何名称）
• URL：输入您的 MCP 服务器正在运行的 URL（例如，对于本地开发使用 http://localhost:3000）
• 点击“添加 MCP”

4.2 替代方法：通过命令配置 MCP 连接

• 您首先需要构建项目并提供编译后的服务器完整路径
• 将以下内容添加到您的 Claude Desktop 配置中：

"ts-prompts": {
  "command": "node",
  "args": [
    "YOUR_CUSTOM_PATH/dist/index.js"
  ]
}

1. 启用 MCP

   • 切换新开关以启用您刚添加的 MCP
   • Claude Desktop 将尝试连接到您的 MCP 服务器

2. 添加本地开发 MCP

   • 重复步骤 3-5 也将 Local Dev MCP 添加到 Claude Desktop
   • 同时启用两个 MCP 可以实现从规划到实施的完整工作流程

3. 验证连接

   • 开始与 Claude 的新对话
   • 请求 Claude 帮助您规划一个 TypeScript 项目或 API 架构
   • Claude 应该现在能够使用提示模板来提供详细的计划
   • 然后请求 Claude 使用 Local Dev MCP 实施计划

使用 Claude 的示例

一旦连接了两个 MCP，您可以要求 Claude：

• “你能帮我为一个名为 'ecommerce-backend' 的 TypeScript 项目规划 API 架构吗？该项目使用 MongoDB 和 JWT 认证？”（使用此 Prompt MCP）
• “我需要一个新 TypeScript 前端库的设置计划，包含 React 组件”（使用此 Prompt MCP）
• “为我的 TypeScript CLI 项目创建一个 GitHub 工作流计划，包括自动化测试和 npm 发布”（使用此 Prompt MCP）
• “现在使用 Local Dev MCP 实现我们刚刚规划的 API 项目”（使用 Local Dev MCP）
• “根据我们创建的计划设置 TypeScript 项目”（使用 Local Dev MCP）

这种 MCP 的组合创造了一个强大的工作流程，您可以在不离开 Claude 界面的情况下详细规划您的项目并进行实施。

🧠 可用的提示

服务器提供了几个可以由 AI 助手使用的提示：

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）

🔍 工作原理

服务器使用 ModelContextProtocol SDK 创建一个 MCP 服务器：

1. 使用 zod 进行验证，定义带参数的结构化提示
2. 每个提示返回一个格式化的消息，指导 AI 助手生成全面的计划
3. 提示包括关于计划中应包含内容的详细说明
4. 通过传输（通常是 stdio）连接到 Claude 或其他兼容 MCP 的 AI 助手

🛠️ 项目结构

src/
  ├── index.ts                # Entry point that sets up the MCP server
  ├── prompts/                # Prompt definitions
  │   ├── apiArchitecture.ts  # API architecture prompt
  │   ├── githubWorkflow.ts   # GitHub workflow prompt
  │   ├── newProjectSetup.ts  # New project setup prompt
  │   └── index.ts            # Exports all prompts
scripts/
  ├── prepare-build.ts        # Script for preparing production builds
  ├── run-relevant-tests.ts   # Script for running tests on changed files
  └── setup-husky.js          # Script for setting up Git hooks

⚙️ 开发

添加新提示

要添加一个新的提示模板：

1. 在 src/prompts 目录下创建一个新文件
2. 使用 mcpServer.prompt() 方法定义您的提示
3. 使用 zod 模式添加参数验证
4. 在 src/prompts/index.ts 中导出您的提示

示例：

import { z } from 'zod';
import { mcpServer } from '../index';

mcpServer.prompt(
  'my-new-prompt',
  'Description of what this prompt does',
  {
    param1: z.string().describe('Description of param1'),
    param2: z.number().optional().describe('Description of param2'),
  },
  async ({ param1, param2 = 0 }) => {
    return {
      messages: [
        {
          role: 'user',
          content: {
            type: 'text',
            text: `Your prompt template with ${param1} and ${param2}...`,
          },
        },
      ],
    };
  },
);

环境配置

服务器在开发和生产环境中使用不同的环境文件：

• .env.development - 在开发模式下运行时使用
• .env.production - 在生产模式下运行时使用

测试

运行测试套件：

npm test

代码检查与格式化

# Run ESLint
npm run lint

# Fix ESLint errors
npm run lint:fix

# Format code with Prettier
npm run format

# Check formatting
npm run format:check

📝 部署注意事项

部署到生产环境时：

1. 确保您的 .env.production 文件中包含有效的凭证（如果需要的话）
2. 构建过程会将这些凭证嵌入编译后的代码中
3. 使用 npm run prod 来构建并启动生产服务器

📄 许可证

此项目根据 MIT 许可证许可 - 详情请参阅 LICENSE 文件。

作者

Gpaul | Faldin