hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

Provides templates for designing GitHub workflow plans including branch strategies, PR templates, and CI/CD configurations
Supports generating API architecture plans with MongoDB integration as a database option
Supports generating API architecture plans with MySQL integration as a database option

TypeScript 提示 MCP 服务器

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

🌟 概述

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

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

此 MCP 专为与 Local Dev MCP 协同工作而设计，形成强大的组合：Prompt MCP 生成详细的项目计划，Local Dev MCP 执行这些计划。两者共同构建了 AI 辅助 TypeScript 项目开发的无缝工作流程。

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

🚀 功能

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

📋 先决条件

Node.js（v14 或更高版本）
npm 或 yarn

🔧 安装

克隆存储库
git clone <repository-url> cd typescript-prompt-mcp
安装依赖项
npm install
设置环境变量
# 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

🔗 与 Local Dev MCP 和 Claude Desktop 集成

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

启动 MCP 服务器确保您的服务器在本地运行。
打开 Claude 桌面设置
- 启动 Claude Desktop
- 点击右上角的个人资料图片或图标
- 从下拉菜单中选择“设置”
导航至扩展设置
- 在“设置”侧栏中，点击“扩展”
- 选择“添加自定义 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"
  ]
}

启用 MCP
- 切换新添加的 MCP 旁边的开关以启用它
- Claude Desktop 将尝试连接到您的 MCP 服务器
添加本地开发 MCP
- 重复步骤 3-5，将 Local Dev MCP 添加到 Claude Desktop
- 启用两个 MCP 可实现从规划到实施的完整工作流程
验证连接
- 与 Claude 开始新的对话
- 让 Claude 帮助您规划 TypeScript 项目或 API 架构
- Claude 现在应该能够使用提示模板来提供详细的计划
- 然后让 Claude 使用 Local Dev MCP 来实现计划

Claude 的用法示例

一旦与两个 MCP 建立连接，您就可以要求 Claude 执行以下操作：

“您能帮我为一个名为‘ecommerce-backend’的 TypeScript 项目规划一个 API 架构，并使用 MongoDB 和 JWT 身份验证吗？”（使用此 Prompt MCP）
“我需要一个带有 React 组件的新 TypeScript 前端库的设置计划”（使用此 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、前端、库、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服务器：

它使用 zod 定义带有参数的结构化提示进行验证
每个提示都会返回一条格式化的消息，指导人工智能助手生成全面的计划
提示包含有关计划中应包含哪些内容的详细说明
服务器通过传输（通常是 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

⚙️ 开发

添加新提示

要添加新的提示模板：

在src/prompts目录中创建一个新文件
使用mcpServer.prompt()方法定义提示
使用 zod 模式添加参数验证
在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

📝 部署注意事项

部署到生产环境时：

如果需要，请确保您的.env.production文件包含有效的凭据
构建过程会将这些凭证嵌入到编译的代码中
使用npm run prod构建并启动生产服务器

📄 许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅LICENSE文件。

作者

Gpaul | Faldin

This server cannot be installed

-

security - not tested

A

license - permissive license

-

quality - not tested

为 AI 助手提供预定义的提示模板，以便为 TypeScript 项目、API 架构和 GitHub 工作流程生成全面的计划。

Appeared in Searches

Developing a System Using TypeScript