README
🚀 欢迎文本生成器MCP服务器
这是一个模型上下文协议(MCP)服务器,用于自动为新员工生成专业的欢迎文本。它可以从自由文本信息中提取结构化数据,并创建模块化、可定制的入职文本。
✨ 主要特性
- 📝 文本分析:处理有关员工的自由文本信息。
- 🎯 模块化模板系统:提供5个灵活的模块,每个模块有不同的变体。
- 💾 数据存储:存储提取的数据,供日后使用。
- 🔄 概览管理:列出所有存储的员工数据。
📦 安装指南
前提条件
- Node.js(v18或更高版本)
- Claude桌面应用程序
步骤1:通过NPM安装
npm install -g welcome-text-generator-mcp
或者,进行本地开发:
git clone https://github.com/goodfel10w/WelcomeTextGenerator.git
cd WelcomeTextGenerator
npm install
npm run build
步骤2:Claude桌面配置
打开Claude桌面配置文件:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
添加MCP服务器: 如果是通过NPM全局安装:
{
"mcpServers": {
"welcome-text-generator": {
"command": "npx",
"args": ["welcome-text-generator-mcp"],
"env": {}
}
}
}
如果是本地开发安装:
{
"mcpServers": {
"welcome-text-generator": {
"command": "node",
"args": [
"C:\\Pfad\\zum\\Projekt\\dist\\index.js"
],
"env": {}
}
}
}
步骤3:重新启动Claude桌面应用程序
重新启动Claude桌面应用程序,以便加载MCP服务器。
💻 使用示例
可用工具
1. extract_from_text
从自由文本中提取结构化数据。 参数:
text(字符串):包含员工信息的自由文本。 示例:
{
"text": "Max Mustermann - Senior Developer mit 5 Jahren Erfahrung. Skills: JavaScript, TypeScript, React..."
}
2. generate_modular_welcome_text
根据模板系统生成模块化的欢迎文本。 参数:
data(对象):提取的员工数据name(字符串,必填)position(字符串,可选)previousCompany(字符串,可选)skills(数组,必填)experience(字符串,可选)achievements(数组,必填)interests(数组,必填)
moduleOptions(对象,可选):includeCompetencies(布尔值,默认值:true):包含模块2includeFunFact(布尔值,默认值:false):包含模块3includeExperience(布尔值,默认值:true):包含模块4introductionVariant(字符串,默认值:"variant1"):"variant1"、"variant2"或"variant3"closingVariant(字符串,默认值:"variant1"):"variant1"、"variant2"或"variant3"
3. list_extracted_data
列出所有存储的员工数据。 无需参数
模块系统
生成的文本由5个模块组成:
模块1:欢迎与介绍(必填)
有3种变体可供选择:
- 变体1:"Welcome to [NAME]! Mit einem frischen Blick..."
- 变体2:"Wir freuen uns riesig, [NAME] bei uns begrüßen zu dürfen!..."
- 变体3:"Ein herzliches Willkommen an [NAME]!..."
模块2:能力与优势(可选)
描述员工的专业知识和热情。
模块3:趣味事实(可选)
关于员工的个人有趣信息。
模块4:职业发展(可选)
关于员工以往职业经历和成就的信息。
模块5:结束语与欢迎问候(必填)
有3种变体可供选择:
- 变体1:"Herzlich willkommen im Team, [NAME]!..."
- 变体2:"Wir freuen uns sehr, dich an Bord zu haben, [NAME]!..."
- 变体3:"Schön, dass du jetzt Teil unseres Teams bist, [NAME]!..."
实际使用示例
在Claude聊天中:
我:以下是我们新员工的信息:
Max Mustermann - 拥有5年经验的高级开发人员,精通JavaScript、TypeScript和React。
曾在TechCorp工作,并领导过多个成功的项目。
是一位狂热的马拉松爱好者。
Claude:我从文本中提取数据...
[使用extract_from_text工具]
我:使用变体2生成欢迎文本,并添加一个趣味事实。
Claude:[使用generate_modular_welcome_text并设置相应选项]
输出:
我们非常高兴能欢迎Max Mustermann加入我们!
从现在起,他将作为高级开发人员加强我们的开发团队,并带来宝贵的经验和新的灵感。
Max不仅拥有丰富的JavaScript和TypeScript知识,还对现代Web开发充满热情和活力。
关于Max的趣味事实:你知道吗,他是一位狂热的马拉松爱好者!也许我们很快能在团队中一起体验!
热烈欢迎Max Mustermann加入团队!让我们一起创造伟大的成就。很高兴你加入我们!
🔧 技术细节
数据存储
所有提取的数据将自动存储在:
<项目目录>/data/extracted_data.json
每个条目包含:
id:唯一ID(时间戳)timestamp:ISO 8601时间戳source:数据来源("手动文本输入")data:提取的员工数据
开发
本地启动项目
npm run dev
构建项目
npm run build
运行测试
npm test
技术栈
- TypeScript:类型安全的代码
- MCP SDK:模型上下文协议集成
- Zod:模式验证
项目结构
welcome-text-generator-mcp/
├── src/
│ ├── index.ts # 服务器入口点
│ ├── types.ts # TypeScript类型
│ ├── tools/ # MCP工具
│ │ ├── extractFromTextTool.ts
│ │ ├── generateModularTextTool.ts
│ │ └── listDataTool.ts
│ ├── utils/ # 辅助函数
│ │ ├── textExtractor.ts
│ │ └── moduleTextGenerator.ts
│ ├── templates/ # 文本模板
│ │ └── moduleTemplates.ts
│ └── storage/ # 数据存储
│ └── dataStorage.ts
├── dist/ # 编译后的文件
├── data/ # 存储的数据
├── package.json
├── tsconfig.json
└── README.md
📄 许可证
本项目采用MIT许可证,请参阅LICENSE文件。
贡献
欢迎贡献代码!请创建一个Pull Request或打开一个Issue。
支持
如有任何问题或疑问:
- GitHub问题:https://github.com/goodfel10w/WelcomeTextGenerator/issues
- MCP文档:https://modelcontextprotocol.io
更新日志
版本1.0.0
- 初始版本发布
- 文本提取和分析
- 具有5个模块的模块化模板系统
- 数据存储和管理
- 介绍和结束语各有3种变体
Scan to join WeChat group