article
README
🚀 Erick 的项目 - 用 MCP 构建的类型安全工具
本项目是基于模型上下文协议(MCP)构建的类型安全工具,借助 TypeScript 和 Zod 实现严格的模式验证。它采用模块化架构,支持直接使用 TypeScript 而无需转译,还生成了 GenQL 的 SDK,为开发者带来诸多便利。
🚀 快速开始
该项目要求使用 Node.js v23+,因为它利用了去年新增的原生 TypeScript 支持。
✨ 主要特性
- 类型安全:使用 TypeScript 和 Zod 进行严格模式验证。
- 原生 TypeScript 支持:可直接在 Node.js 中运行,无需转译。
- 模块化架构:采用分层设计,有效分离关注点。
- 生成的 GenQL SDK:提供强大的查询功能。
- 标准 I/O 传输:易于集成到现有项目中。
- 结构化的错误处理:让错误排查更加高效。
- 兼容性良好:支持 Claude Desktop、Cursor 和 MCPHost(免费替代方案)。
📦 安装指南
此部分文档未提及具体安装命令,故跳过。
💻 使用示例
基础用法
此部分文档未提供代码示例,故跳过。
📚 详细文档
项目结构
src/
├── config/ # 配置设置
├── types/ # TypeScript 接口和类型
├── tools/ # MCP 工具实现
├── utils/ # 工具函数
├── services/ # API 服务层
└── index.ts # 入口文件
开发
功能
- 使用 Model Context Protocol (MCP) 构建。
- 类型安全的 TypeScript。
- 原生 TypeScript 支持,无需转译。
- 使用 GenQL 生成 SDK。
- 模块化架构,分离关注点。
- 标准 I/O 传输,便于集成。
- 结构化的错误处理。
开发模式
为了运行测试套件:
npm 测试
开发模式下带.watch:
npm 运行测试:dev
🔧 技术细节
此部分文档未提供具体的技术说明(少于 50 字),故跳过。
📄 许可证
本项目在 MIT 许可证下发行。详细信息请参阅 LICENSE 文件。
👥 贡献
欢迎贡献!请随意提交 Pull Request。
扫码联系在线客服