Create MCP Ts

🚀 如何使用 create-mcp-ts 快速搭建 TypeScript 項目

本項目提供了 create-mcp-ts 工具，能幫助開發者快速搭建 TypeScript 項目，節省項目初始化的時間和精力。

🚀 快速開始

安裝

使用 create-mcp-ts 前，你需要先進行安裝，支持使用 npm 或 yarn 進行全局安裝。

# 使用 npm 安裝
npm install -g create-mcp-ts

# 或者使用 yarn 安裝
yarn global add create-mcp-ts

創建項目

安裝完成後，你可以在終端中運行以下命令來創建項目，運行命令後需輸入項目名稱。

create-mcp-ts <project-name>

例如，創建一個名為 mcp-project 的項目：

create-mcp-ts mcp-project

創建完成後，進入生成的項目目錄：

cd mcp-project

啟動開發服務器

進入項目目錄後，運行以下命令啟動開發服務器：

npm run dev

默認情況下，開發服務器會在 http://localhost:3000 開啟服務。

構建生產環境

當項目開發完成後，運行以下命令進行項目構建：

npm run build

構建後的文件會存放在 dist 文件夾中。

📦 安裝指南

• 使用 npm 全局安裝：npm install -g create-mcp-ts
• 使用 yarn 全局安裝：yarn global add create-mcp-ts

💻 使用示例

提供類型定義

在項目的根目錄下創建或修改 declaration.d.ts 文件，添加以下內容以提供全局類型定義：

declare namespace NodeJS {
  interface ProcessEnv {
    NODE_ENV: 'development' | 'production';
    PORT: string;
  }
}

interface Window {
  __env__: {
    NODE_ENV: string;
    PORT: string;
  };
}

環境變量的使用

在項目中使用環境變量：

import { env } from '$process';

const port = env.PORT; // 或者直接訪問 process.env.PORT

配置

你可以修改 tsconfig.json 和其他配置文件以滿足項目需求。

📚 詳細文檔

貢獻指南

歡迎大家為項目做出貢獻！如果你想貢獻代碼，請 fork 倉庫並提交 Pull Request。

📄 許可證

本項目遵循 MIT 許可證。