Skip to content

Kiro spec kit project specification tool based on fastjsmcp.An example project to show how to use fastjsmcp to build a mcp server.

Notifications You must be signed in to change notification settings

zaizaizhao/fastjsmcp-kiro-spec

Repository files navigation

Kiro Spec Kit - MCP 服务器

基于 fastjsmcp 构建的 Model Context Protocol (MCP) 服务器,提供项目规范生成工具集。这是一个展示如何使用 fastjsmcp 构建 MCP 服务器的示例项目。

🚀 特性

  • MCP 服务器 - 基于 fastjsmcp 1.0.7 构建的 MCP 服务器
  • 项目规范生成 - 自动生成项目规范文档
  • 项目设计文档 - 生成项目设计文档
  • 任务管理 - 生成项目实施任务文档
  • 实施规范 - 项目实施规范细节约束
  • TypeScript 支持 - 完整的 TypeScript 类型支持
  • 热重载开发 - 开发时自动重启服务器

📁 项目结构

├── src/                    # 源代码目录
│   ├── index.ts           # MCP 服务器主文件
│   └── prompts/           # 提示词模板目录
│       ├── design.md      # 项目设计模板
│       ├── implement.md   # 实施规范模板
│       ├── spec.md        # 项目规范模板
│       └── tasks.md       # 任务管理模板
├── dist/                  # 编译输出目录
│   ├── index.js          # 编译后的主文件
│   ├── index.d.ts        # TypeScript 声明文件
│   └── *.map             # 源码映射文件
├── .eslintrc.js          # ESLint 配置
├── .prettierrc           # Prettier 配置
├── jest.config.js        # Jest 测试配置
├── tsconfig.json         # TypeScript 配置
├── package.json          # 项目配置和依赖
└── README.md             # 项目说明文档

🛠️ 安装和使用

1. 安装依赖

# 使用 pnpm(推荐)
pnpm install

# 或使用 npm
npm install

# 或使用 yarn
yarn install

2. 启动 MCP 服务器

# 开发模式启动(推荐)
pnpm run dev

# 或者先构建再启动
pnpm run build
pnpm start

服务器将在 http://localhost:4006/mcp 启动。

3. 健康检查

# 检查服务器状态
curl http://localhost:4006/health

🔧 MCP 工具说明

本服务器提供以下 MCP 工具:

工具列表

  1. generate_project_spec_tool - 生成项目规范

    • 参数:content (string) - 项目名字
    • 功能:根据项目名称生成项目规范文档
  2. generate_project_design_tool - 生成项目设计文档

    • 功能:生成项目设计文档
  3. generate_project_tasks_tool - 生成项目实施任务文档

    • 功能:生成项目实施任务文档
  4. generate_project_implement_tool - 项目实施规范细节约束

    • 功能:生成项目实施规范细节约束

提示词

  • generate_project_spec - 生成项目规范提示词

📝 可用脚本

脚本 描述
pnpm run build 编译 TypeScript 代码到 dist 目录
pnpm start 使用 tsx 运行 TypeScript 代码
pnpm run dev 启动 fastjsmcp 开发服务器
pnpm run watch 使用 nodemon 监听文件变化并自动重启
pnpm test 运行 Jest 测试
pnpm run test:watch 监听模式运行测试
pnpm run lint 运行 ESLint 代码检查
pnpm run lint:fix 自动修复 ESLint 问题
pnpm run format 使用 Prettier 格式化代码

🔧 配置说明

TypeScript 配置 (tsconfig.json)

  • 目标版本:ES2020
  • 模块系统:ESNext
  • 严格模式:启用
  • 源码映射:启用
  • 声明文件:启用

MCP 服务器配置

  • 服务器名称:kiroSpectKit
  • 版本:1.0.0
  • 传输类型:Streamable
  • 端口:4006
  • 主机:localhost
  • 端点:/mcp

🚀 开发指南

添加新工具

  1. KiroSpectKit 类中添加新方法
  2. 使用 @tool 装饰器标记方法
  3. 定义输入参数 schema
  4. 实现工具逻辑

示例:

@tool({
  name: 'my_new_tool',
  description: '我的新工具',
  inputSchema: Schema.object({
    param: Schema.string().describe('参数描述'),
  }),
})
async myNewTool(args: { param: string }) {
  // 工具实现逻辑
  return `处理结果: ${args.param}`;
}

添加新提示词

  1. prompts/ 目录下创建新的 .md 文件
  2. 在类中添加对应的 @prompt 方法
  3. 读取并返回提示词内容

📦 依赖说明

核心依赖

  • fastjsmcp: MCP 服务器框架

开发依赖

  • TypeScript: 类型支持
  • ESLint: 代码检查
  • Prettier: 代码格式化
  • Jest: 测试框架
  • tsx: TypeScript 执行器
  • nodemon: 文件监听和自动重启

📄 许可证

MIT License

🤝 贡献

欢迎提交 Issue 和 Pull Request 来改进这个 MCP 服务器项目!

📚 相关资源

About

Kiro spec kit project specification tool based on fastjsmcp.An example project to show how to use fastjsmcp to build a mcp server.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published