TypeScript Prompt MCP Server

TypeScript提示MCP服务器

模型上下文协议（MCP）服务器，为人工智能助手提供预定义的提示模板，使他们能够为TypeScript项目、API架构和GitHub工作流生成全面的计划。

 ](https://nodejs.org/)

🌟 概述

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

• 制定全面的API体系结构计划
• 使用最佳实践设置新的TypeScript项目
• 生成GitHub工作流配置

此MCP是专门为与本地开发MCP配合使用而创建的，形成了一个强大的组合，其中提示MCP生成详细的项目计划，本地开发MCP执行这些计划。它们共同为人工智能辅助的TypeScript项目开发创建了一个无缝的工作流程。

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

🚀 特性

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

📋 先决条件

• Node.js（v14或更高版本）
• npm或纱线

🔧 安装

1. 克隆存储库

   git clone 
   cd typescript-prompt-mcp

1. 安装依赖项

   npm install

1. 设置环境变量

   # Create development environment file
   cp .env.example .env.development
   # Create production environment file
   cp .env.example .env.production

🎮 用法

发展模式

npm run dev

这将以热重新加载的方式启动处于开发模式的MCP服务器。

生产模式

npm run build
npm start

或者使用简写：

npm run prod

🔗 与本地开发MCP和Claude桌面集成

要将此MCP服务器添加到Claude Desktop，请执行以下操作：

1. 启动MCP服务器

确保您的服务器正在本地运行。

1. 打开克劳德桌面设置

- 启动克劳德桌面 - 点击右上角的个人资料图片或图标 - 从下拉菜单中选择“设置”

1. 导航到扩展设置

- 在设置侧栏中，单击“扩展” - 选择“添加自定义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服务器

1. 添加本地开发MCP

- 重复步骤3-5，将本地开发MCP添加到Claude Desktop - 启用这两个MCP可以实现从规划到实施的完整工作流程

1. 验证连接

- 与克劳德开始新的对话 - 请Claude帮助您规划TypeScript项目或API架构 - Claude现在应该能够使用提示模板提供详细的计划 - 然后让Claude使用本地开发MCP实施该计划

Claude使用示例

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

• “你能帮我为一个名为‘电子商务后台’的TypeScript项目规划一个API架构吗？”（使用此Prompt MCP）
• “我需要一个带有React组件的新TypeScript前端库的设置计划”（使用此Prompt MCP）
• “为我的TypeScript CLI项目创建一个GitHub工作流计划，包括自动测试和npm发布”（使用此Prompt MCP）
• “现在使用本地开发MCP实施我们刚才计划的API项目”（使用本地开发人员MCP）
• “使用我们创建的计划设置TypeScript项目”（使用本地开发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、前端、库、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. 每个提示都会返回一条格式化的消息，指导人工智能助手生成全面的计划
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许可证获得许可-请参阅 许可证 文件以获取详细信息。

作者

Gpaul | 谢谢