create-glosc 0.1.0 → 0.2.0

package/README.md

@@ -15,12 +15,15 @@ npm create glosc@latest <your-project-name>
 ```sh
 Project name: <your-project-name>
 Description: A brief description of your project
-Author: Your Name
+Author: <system-username>
 Use Language: Python / TypeScript
 Main File Name: main.py / index.ts
 Readme: Y / N
 License: MIT
 ```
+生成的项目模板现在默认是 **MCP (Model Context Protocol) stdio server**，并内置一个最基础的工具：
+
+- `get_current_time`：返回当前 UTC 时间（ISO 8601 字符串）
 
 
 ### Python结构
@@ -29,9 +32,9 @@ License: MIT
 
 <your-project-name>/
 ├── src/                # 源代码目录
-│   ├── main.py         # 主程序文件 (Python)
-│   ├── pyproject.toml   # 项目配置
-│   └── requirements.txt # 依赖文件
+│   ├── main.py         # MCP Server 入口 (Python, stdio)
+├── pyproject.toml      # 项目配置
+├── requirements.txt    # 依赖文件
 ├── config.yml          # 配置文件
 ├── README.md           # 项目说明文件
 └── LICENSE             # 许可证文件
@@ -43,13 +46,30 @@ License: MIT
 ```sh
 <your-project-name>/
 ├── src/                # 源代码目录
-│   ├── index.ts        # 主程序文件 (TypeScript)
-│   └── package.json    # 依赖文件
+│   ├── index.ts        # MCP Server 入口 (TypeScript, stdio)
+├── package.json        # 依赖文件（含 @modelcontextprotocol/sdk）
 ├── config.yml          # 配置文件
 ├── README.md           # 项目说明文件
 └── LICENSE             # 许可证文件
 ```
 
+### 运行生成的 MCP Server
+
+Python：
+
+```sh
+python -m pip install -r requirements.txt
+python src/main.py
+```
+
+TypeScript：
+
+```sh
+npm install
+npm run build
+npm start
+```
+
 ### 本地开发（维护此 CLI）
 
 ```sh

package/dist/index.js

@@ -38,6 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const prompts_1 = __importDefault(require("prompts"));
 const path = __importStar(require("node:path"));
+const os = __importStar(require("node:os"));
 const scaffold_1 = require("./scaffold");
 function parseArgs(argv) {
     const result = {
@@ -123,18 +124,42 @@ function normalizeMainFileName(language, mainFileNameRaw) {
         return base;
     return `${base}${defaultExt}`;
 }
+function getDefaultAuthor() {
+    const candidates = [
+        process.env.GIT_AUTHOR_NAME,
+        process.env.GIT_COMMITTER_NAME,
+        process.env.USER,
+        process.env.USERNAME,
+        process.env.LOGNAME,
+    ];
+    for (const c of candidates) {
+        const v = String(c || "").trim();
+        if (v)
+            return v;
+    }
+    try {
+        const u = os.userInfo();
+        const name = String(u?.username || "").trim();
+        if (name)
+            return name;
+    }
+    catch {
+        // ignore
+    }
+    return "Your Name";
+}
 async function run() {
     const argv = process.argv.slice(2);
     const args = parseArgs(argv);
     if (args.defaults) {
         if (!args.projectName) {
-            throw new Error("Project name is required (e.g. `npm create glosc-cli@latest my-app -- --defaults`)");
+            throw new Error("Project name is required (e.g. `npm create glosc@latest my-app -- --defaults`)");
         }
         const language = normalizeLanguage(args.language) || "typescript";
         const options = {
             projectName: String(args.projectName).trim(),
             description: String(args.description || "A brief description of your project").trim(),
-            author: String(args.author || "Your Name").trim(),
+            author: String(args.author || getDefaultAuthor()).trim(),
             language,
             mainFileName: normalizeMainFileName(language, args.mainFileName),
             readme: args.readme !== undefined ? Boolean(args.readme) : true,
@@ -146,6 +171,7 @@ async function run() {
     // allow `npm create ... <name>` to prefill
     prompts_1.default.override({
         projectName: args.projectName,
+        author: args.author,
     });
     let selectedLanguage;
     const response = await (0, prompts_1.default)([
@@ -172,7 +198,7 @@ async function run() {
             type: "text",
             name: "author",
             message: "Author:",
-            initial: "Your Name",
+            initial: getDefaultAuthor(),
         },
         {
             type: "select",

package/dist/templates.js

@@ -14,7 +14,11 @@ function mitLicenseText({ author }) {
 function projectReadme(options) {
     const { projectName, description, author, language, mainFileName } = options;
     const langLabel = language === "python" ? "Python" : "TypeScript";
-    return `# ${projectName}\n\n${description || ""}\n\n## Author\n\n${author || ""}\n\n## Language\n\n${langLabel}\n\n## Entry\n\n- src/${mainFileName}\n\n## Config\n\n- config.yml\n`;
+    const entry = `src/${mainFileName}`;
+    const runSection = language === "python"
+        ? `## Run (Python)\n\n\n\n1) Install deps\n\n\n\n\`\`\`sh\npython -m pip install -r requirements.txt\n\`\`\`\n\n\n\n2) Run the MCP server (stdio)\n\n\n\n\`\`\`sh\npython ${entry}\n\`\`\`\n\n\n\nThis server speaks MCP over stdio. Connect using an MCP client (e.g. an editor integration).\n`
+        : `## Run (TypeScript)\n\n\n\n1) Install deps\n\n\n\n\`\`\`sh\nnpm install\n\`\`\`\n\n\n\n2) Build\n\n\n\n\`\`\`sh\nnpm run build\n\`\`\`\n\n\n\n3) Run the MCP server (stdio)\n\n\n\n\`\`\`sh\nnpm start\n\`\`\`\n\n\n\nThis server speaks MCP over stdio. Connect using an MCP client (e.g. an editor integration).\n`;
+    return `# ${projectName}\n\n${description || ""}\n\n## Author\n\n${author || ""}\n\n## Language\n\n${langLabel}\n\n## Entry\n\n- ${entry}\n\n## MCP Tools\n\n- get_current_time: Returns the current time (UTC, ISO 8601)\n\n${runSection}\n\n## Config\n\n- config.yml\n`;
 }
 function configYml(options) {
     const { projectName, description, author, language, mainFileName } = options;
@@ -27,36 +31,43 @@ function configYml(options) {
         "",
     ].join("\n");
 }
-function pythonMain({ projectName, description, }) {
-    const safeName = String(projectName).replace(/"/g, '\\"');
-    const safeDesc = String(description || "").replace(/"/g, '\\"');
-    return `def main():\n    print("${safeName}")\n    ${description ? `print("${safeDesc}")` : "pass"}\n\n\nif __name__ == "__main__":\n    main()\n`;
+function pythonMain({ projectName, }) {
+    const safeName = String(projectName || "mcp-server").replace(/"/g, '\\"');
+    return `from datetime import datetime, timezone\n\nfrom mcp.server.fastmcp import FastMCP\n\n# Minimal MCP server (stdio)\n\nmcp = FastMCP("${safeName}")\n\n\n@mcp.tool()\nasync def get_current_time() -> str:\n    """Return the current time in UTC (ISO 8601)."""\n\n    return datetime.now(timezone.utc).isoformat()\n\n\ndef main():\n    mcp.run(transport="stdio")\n\n\nif __name__ == "__main__":\n    main()\n`;
 }
 function pythonRequirements() {
-    return `# Add your Python dependencies here\n`;
+    return `mcp\n`;
 }
 function pythonPyproject({ projectName, author, }) {
     const safeName = String(projectName || "glosc-project")
         .trim()
         .replace(/\s+/g, "-");
     const safeAuthor = String(author || "").replace(/"/g, '\\"');
-    return `# Minimal pyproject.toml (adjust as needed)\n\n[project]\nname = "${safeName}"\nversion = "0.1.0"\ndescription = ""\nauthors = [{ name = "${safeAuthor}" }]\nrequires-python = ">=3.10"\n\n[build-system]\nrequires = ["setuptools>=61.0"]\nbuild-backend = "setuptools.build_meta"\n`;
+    const authorsLine = safeAuthor.trim()
+        ? `authors = [{ name = "${safeAuthor}" }]\n`
+        : "";
+    return `# Minimal pyproject.toml (adjust as needed)\n\n[project]\nname = "${safeName}"\nversion = "0.1.0"\ndescription = ""\n${authorsLine}requires-python = ">=3.10"\ndependencies = [\n  "mcp",\n]\n\n[build-system]\nrequires = ["setuptools>=61.0"]\nbuild-backend = "setuptools.build_meta"\n`;
 }
 function nodePackageJson(options) {
     const { projectName, description, author, mainFileName } = options;
-    const main = mainFileName.replace(/\.ts$/i, ".js");
+    const distEntry = `dist/${mainFileName.replace(/\.ts$/i, ".js")}`;
     const pkg = {
         name: projectName,
         version: "0.1.0",
         description: description || "",
         author: author || "",
         private: true,
+        type: "module",
         scripts: {
             build: "tsc -p .",
-            start: `node ${main}`,
+            start: `node ${distEntry}`,
+        },
+        dependencies: {
+            "@modelcontextprotocol/sdk": "^1.24.3",
         },
         devDependencies: {
-            typescript: "^5.3.3",
+            typescript: "^5.9.3",
+            "@types/node": "^22.19.2",
         },
     };
     return JSON.stringify(pkg, null, 2) + "\n";
@@ -64,20 +75,23 @@ function nodePackageJson(options) {
 function tsConfig() {
     return (JSON.stringify({
         compilerOptions: {
-            target: "ES2020",
-            module: "CommonJS",
+            target: "ES2022",
+            module: "Node16",
             strict: true,
-            outDir: ".",
-            rootDir: ".",
+            outDir: "dist",
+            rootDir: "src",
             esModuleInterop: true,
+            moduleResolution: "Node16",
+            types: ["node"],
+            skipLibCheck: true,
+            forceConsistentCasingInFileNames: true,
         },
-        include: ["*.ts"],
+        include: ["src/**/*.ts"],
     }, null, 2) + "\n");
 }
-function tsMain({ projectName, description, }) {
-    const safeName = String(projectName).replace(/`/g, "\\`");
-    const safeDesc = String(description || "").replace(/`/g, "\\`");
-    return `console.log("${safeName}");\n${description ? `console.log("${safeDesc}");\n` : ""}`;
+function tsMain({ projectName }) {
+    const safeName = String(projectName || "mcp-server").replace(/"/g, '\\"');
+    return `import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";\nimport { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";\n\nconst server = new McpServer({\n  name: "${safeName}",\n  version: "0.1.0",\n});\n\nserver.registerTool(\n  "get_current_time",\n  {\n    title: "Get Current Time",\n    description: "Return the current time in UTC (ISO 8601)",\n    inputSchema: {},\n  },\n  async () => {\n    return {\n      content: [\n        {\n          type: "text",\n          text: new Date().toISOString(),\n        },\n      ],\n    };\n  },\n);\n\nasync function main() {\n  const transport = new StdioServerTransport();\n  await server.connect(transport);\n  console.error("MCP Server running on stdio");\n}\n\nmain().catch((error) => {\n  console.error("Fatal error in main():", error);\n  process.exit(1);\n});\n`;
 }
 function getProjectFiles(options) {
     const files = [];
@@ -100,11 +114,11 @@ function getProjectFiles(options) {
             content: pythonMain(options),
         });
         files.push({
-            relativePath: "src/requirements.txt",
+            relativePath: "requirements.txt",
             content: pythonRequirements(),
         });
         files.push({
-            relativePath: "src/pyproject.toml",
+            relativePath: "pyproject.toml",
             content: pythonPyproject(options),
         });
     }
@@ -114,10 +128,10 @@ function getProjectFiles(options) {
             content: tsMain(options),
         });
         files.push({
-            relativePath: "src/package.json",
+            relativePath: "package.json",
             content: nodePackageJson(options),
         });
-        files.push({ relativePath: "src/tsconfig.json", content: tsConfig() });
+        files.push({ relativePath: "tsconfig.json", content: tsConfig() });
     }
     return files;
 }

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "create-glosc",
-    "version": "0.1.0",
-    "description": "Scaffold Glosc projects (Python/TypeScript/JavaScript) via npm create",
+    "version": "0.2.0",
+    "description": "Scaffold Glosc projects (Python/TypeScript) via npm create",
     "author": "glosc-ai",
     "license": "MIT",
     "bin": {
+        "create-glosc": "bin/index.js",
         "glosc": "bin/index.js"
     },
     "type": "commonjs",

package/src/index.ts

@@ -1,5 +1,6 @@
 import prompts from "prompts";
 import * as path from "node:path";
+import * as os from "node:os";
 import { scaffoldProject } from "./scaffold";
 
 type Language = "python" | "typescript";
@@ -128,6 +129,31 @@ function normalizeMainFileName(
     return `${base}${defaultExt}`;
 }
 
+function getDefaultAuthor(): string {
+    const candidates = [
+        process.env.GIT_AUTHOR_NAME,
+        process.env.GIT_COMMITTER_NAME,
+        process.env.USER,
+        process.env.USERNAME,
+        process.env.LOGNAME,
+    ];
+
+    for (const c of candidates) {
+        const v = String(c || "").trim();
+        if (v) return v;
+    }
+
+    try {
+        const u = os.userInfo();
+        const name = String(u?.username || "").trim();
+        if (name) return name;
+    } catch {
+        // ignore
+    }
+
+    return "Your Name";
+}
+
 async function run(): Promise<void> {
     const argv = process.argv.slice(2);
     const args = parseArgs(argv);
@@ -135,7 +161,7 @@ async function run(): Promise<void> {
     if (args.defaults) {
         if (!args.projectName) {
             throw new Error(
-                "Project name is required (e.g. `npm create glosc-cli@latest my-app -- --defaults`)"
+                "Project name is required (e.g. `npm create glosc@latest my-app -- --defaults`)"
             );
         }
 
@@ -146,7 +172,7 @@ async function run(): Promise<void> {
             description: String(
                 args.description || "A brief description of your project"
             ).trim(),
-            author: String(args.author || "Your Name").trim(),
+            author: String(args.author || getDefaultAuthor()).trim(),
             language,
             mainFileName: normalizeMainFileName(language, args.mainFileName),
             readme: args.readme !== undefined ? Boolean(args.readme) : true,
@@ -160,6 +186,7 @@ async function run(): Promise<void> {
     // allow `npm create ... <name>` to prefill
     prompts.override({
         projectName: args.projectName,
+        author: args.author,
     });
 
     let selectedLanguage: Language | undefined;
@@ -188,7 +215,7 @@ async function run(): Promise<void> {
                 type: "text",
                 name: "author",
                 message: "Author:",
-                initial: "Your Name",
+                initial: getDefaultAuthor(),
             },
             {
                 type: "select",

package/src/templates.ts

@@ -32,9 +32,15 @@ function projectReadme(options: ProjectOptions): string {
         options;
     const langLabel = language === "python" ? "Python" : "TypeScript";
 
+    const entry = `src/${mainFileName}`;
+    const runSection =
+        language === "python"
+            ? `## Run (Python)\n\n\n\n1) Install deps\n\n\n\n\`\`\`sh\npython -m pip install -r requirements.txt\n\`\`\`\n\n\n\n2) Run the MCP server (stdio)\n\n\n\n\`\`\`sh\npython ${entry}\n\`\`\`\n\n\n\nThis server speaks MCP over stdio. Connect using an MCP client (e.g. an editor integration).\n`
+            : `## Run (TypeScript)\n\n\n\n1) Install deps\n\n\n\n\`\`\`sh\nnpm install\n\`\`\`\n\n\n\n2) Build\n\n\n\n\`\`\`sh\nnpm run build\n\`\`\`\n\n\n\n3) Run the MCP server (stdio)\n\n\n\n\`\`\`sh\nnpm start\n\`\`\`\n\n\n\nThis server speaks MCP over stdio. Connect using an MCP client (e.g. an editor integration).\n`;
+
     return `# ${projectName}\n\n${description || ""}\n\n## Author\n\n${
         author || ""
-    }\n\n## Language\n\n${langLabel}\n\n## Entry\n\n- src/${mainFileName}\n\n## Config\n\n- config.yml\n`;
+    }\n\n## Language\n\n${langLabel}\n\n## Entry\n\n- ${entry}\n\n## MCP Tools\n\n- get_current_time: Returns the current time (UTC, ISO 8601)\n\n${runSection}\n\n## Config\n\n- config.yml\n`;
 }
 
 function configYml(options: ProjectOptions): string {
@@ -52,18 +58,14 @@ function configYml(options: ProjectOptions): string {
 
 function pythonMain({
     projectName,
-    description,
 }: Pick<ProjectOptions, "projectName" | "description">): string {
-    const safeName = String(projectName).replace(/"/g, '\\"');
-    const safeDesc = String(description || "").replace(/"/g, '\\"');
+    const safeName = String(projectName || "mcp-server").replace(/"/g, '\\"');
 
-    return `def main():\n    print("${safeName}")\n    ${
-        description ? `print("${safeDesc}")` : "pass"
-    }\n\n\nif __name__ == "__main__":\n    main()\n`;
+    return `from datetime import datetime, timezone\n\nfrom mcp.server.fastmcp import FastMCP\n\n# Minimal MCP server (stdio)\n\nmcp = FastMCP("${safeName}")\n\n\n@mcp.tool()\nasync def get_current_time() -> str:\n    """Return the current time in UTC (ISO 8601)."""\n\n    return datetime.now(timezone.utc).isoformat()\n\n\ndef main():\n    mcp.run(transport="stdio")\n\n\nif __name__ == "__main__":\n    main()\n`;
 }
 
 function pythonRequirements(): string {
-    return `# Add your Python dependencies here\n`;
+    return `mcp\n`;
 }
 
 function pythonPyproject({
@@ -76,12 +78,16 @@ function pythonPyproject({
 
     const safeAuthor = String(author || "").replace(/"/g, '\\"');
 
-    return `# Minimal pyproject.toml (adjust as needed)\n\n[project]\nname = "${safeName}"\nversion = "0.1.0"\ndescription = ""\nauthors = [{ name = "${safeAuthor}" }]\nrequires-python = ">=3.10"\n\n[build-system]\nrequires = ["setuptools>=61.0"]\nbuild-backend = "setuptools.build_meta"\n`;
+    const authorsLine = safeAuthor.trim()
+        ? `authors = [{ name = "${safeAuthor}" }]\n`
+        : "";
+
+    return `# Minimal pyproject.toml (adjust as needed)\n\n[project]\nname = "${safeName}"\nversion = "0.1.0"\ndescription = ""\n${authorsLine}requires-python = ">=3.10"\ndependencies = [\n  "mcp",\n]\n\n[build-system]\nrequires = ["setuptools>=61.0"]\nbuild-backend = "setuptools.build_meta"\n`;
 }
 
 function nodePackageJson(options: ProjectOptions): string {
     const { projectName, description, author, mainFileName } = options;
-    const main = mainFileName.replace(/\.ts$/i, ".js");
+    const distEntry = `dist/${mainFileName.replace(/\.ts$/i, ".js")}`;
 
     const pkg: Record<string, unknown> = {
         name: projectName,
@@ -89,12 +95,17 @@ function nodePackageJson(options: ProjectOptions): string {
         description: description || "",
         author: author || "",
         private: true,
+        type: "module",
         scripts: {
             build: "tsc -p .",
-            start: `node ${main}`,
+            start: `node ${distEntry}`,
+        },
+        dependencies: {
+            "@modelcontextprotocol/sdk": "^1.24.3",
         },
         devDependencies: {
-            typescript: "^5.3.3",
+            typescript: "^5.9.3",
+            "@types/node": "^22.19.2",
         },
     };
 
@@ -106,14 +117,18 @@ function tsConfig(): string {
         JSON.stringify(
             {
                 compilerOptions: {
-                    target: "ES2020",
-                    module: "CommonJS",
+                    target: "ES2022",
+                    module: "Node16",
                     strict: true,
-                    outDir: ".",
-                    rootDir: ".",
+                    outDir: "dist",
+                    rootDir: "src",
                     esModuleInterop: true,
+                    moduleResolution: "Node16",
+                    types: ["node"],
+                    skipLibCheck: true,
+                    forceConsistentCasingInFileNames: true,
                 },
-                include: ["*.ts"],
+                include: ["src/**/*.ts"],
             },
             null,
             2
@@ -121,15 +136,10 @@ function tsConfig(): string {
     );
 }
 
-function tsMain({
-    projectName,
-    description,
-}: Pick<ProjectOptions, "projectName" | "description">): string {
-    const safeName = String(projectName).replace(/`/g, "\\`");
-    const safeDesc = String(description || "").replace(/`/g, "\\`");
-    return `console.log("${safeName}");\n${
-        description ? `console.log("${safeDesc}");\n` : ""
-    }`;
+function tsMain({ projectName }: Pick<ProjectOptions, "projectName">): string {
+    const safeName = String(projectName || "mcp-server").replace(/"/g, '\\"');
+
+    return `import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";\nimport { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";\n\nconst server = new McpServer({\n  name: "${safeName}",\n  version: "0.1.0",\n});\n\nserver.registerTool(\n  "get_current_time",\n  {\n    title: "Get Current Time",\n    description: "Return the current time in UTC (ISO 8601)",\n    inputSchema: {},\n  },\n  async () => {\n    return {\n      content: [\n        {\n          type: "text",\n          text: new Date().toISOString(),\n        },\n      ],\n    };\n  },\n);\n\nasync function main() {\n  const transport = new StdioServerTransport();\n  await server.connect(transport);\n  console.error("MCP Server running on stdio");\n}\n\nmain().catch((error) => {\n  console.error("Fatal error in main():", error);\n  process.exit(1);\n});\n`;
 }
 
 export function getProjectFiles(options: ProjectOptions): ProjectFile[] {
@@ -157,11 +167,11 @@ export function getProjectFiles(options: ProjectOptions): ProjectFile[] {
             content: pythonMain(options),
         });
         files.push({
-            relativePath: "src/requirements.txt",
+            relativePath: "requirements.txt",
             content: pythonRequirements(),
         });
         files.push({
-            relativePath: "src/pyproject.toml",
+            relativePath: "pyproject.toml",
             content: pythonPyproject(options),
         });
     }
@@ -172,10 +182,10 @@ export function getProjectFiles(options: ProjectOptions): ProjectFile[] {
             content: tsMain(options),
         });
         files.push({
-            relativePath: "src/package.json",
+            relativePath: "package.json",
             content: nodePackageJson(options),
         });
-        files.push({ relativePath: "src/tsconfig.json", content: tsConfig() });
+        files.push({ relativePath: "tsconfig.json", content: tsConfig() });
     }
 
     return files;