关键词

项目结构生成AI辅助开发代码脚手架自动化开发开发工具

项目简介

StructKit（结构工具包）是一个灵活的项目结构自动化生成工具。它允许你通过YAML配置文件定义项目布局、样板代码和配置。通过其集成的AI功能，大型语言模型（LLM）可以作为客户端与StructKit服务器通信，获取项目结构信息并触发代码生成。

主要功能点

  • 列出结构定义: LLM可以查询所有可用的项目结构模板。
  • 获取结构详情: LLM可以获取特定项目结构的详细定义和说明。
  • 生成项目结构: LLM可以触发StructKit根据指定的模板和参数生成新的项目结构。
  • 验证配置: LLM可以验证项目结构YAML配置文件的语法和逻辑。

安装步骤

  1. 通过pip安装 (推荐): 打开终端并运行以下命令： 
    pip install structkit
  2. 通过Docker运行: 你可以使用Docker镜像在隔离环境中运行StructKit。这将下载并运行StructKit Docker镜像。 
    docker run -v $(pwd):/workdir ghcr.io/httpdss/structkit:main generate my-config.yaml ./output

服务器配置

MCP客户端需要以下配置信息来连接到StructKit MCP服务器。

{
  "name": "StructKit AI开发助手",
  "command": "structkit",
  "args": ["mcp", "--server", "--transport", "stdio"]
}
  • '"name"': MCP服务器的名称，用于客户端识别。
  • '"command"': 启动StructKit命令行工具的命令。
  • '"args"': 传递给命令的参数，用于启动MCP服务器：
    • '"mcp"': 指定运行MCP子命令。
    • '"--server"': 启动MCP服务器模式。
    • '"--transport", "stdio"': 指定使用标准输入/输出 (stdio) 作为通信协议。StructKit也支持 'http' 或 'sse' 传输协议。如果使用 'http' 或 'sse'，还可以可选地指定 '--host' 和 '--port' 参数，例如：'["mcp", "--server", "--transport", "http", "--host", "127.0.0.1", "--port", "8000"]'。

基本使用方法

  1. 启动MCP服务器: 在终端中运行以下命令来启动StructKit MCP服务器： 
    structkit mcp --server --transport stdio
    服务器将开始监听MCP客户端的请求。你也可以选择 'http' 或 'sse' 作为传输协议。
  2. LLM客户端交互: 一个兼容MCP协议的LLM客户端（如支持MCP的IDE插件或AI助手）可以连接到此服务器，并使用以下工具与StructKit进行交互：
    • 'list_structures()': 列出所有可用的项目结构模板。
    • 'get_structure_info(structure_name: str)': 获取特定结构定义的详细信息。
    • 'generate_structure(structure_definition: str, base_path: str, ...)': 根据指定的结构定义和选项生成项目结构。
    • 'validate_structure(yaml_file: str)': 验证YAML配置文件是否符合StructKit的结构定义规范。

信息

分类

开发者工具

访问项目