项目简介
TSEF(The AI-ready Typescript Enterprise Framework)是一个为TypeScript开发者设计的AI就绪企业级框架。其内置的开发工具包(Devkit)包含一个MCP服务器,旨在向AI代理或LLM客户端提供框架的内部信息和功能,例如列出、查询和验证项目生成器,以及访问框架文档。
主要功能点
- 项目生成器管理: 允许查看所有可用的Nx自定义生成器、获取特定生成器的详细信息,并验证生成器选项以预览执行命令。
- 文档访问: 提供列出框架'docs/'目录下所有Markdown文档及其元数据的功能,并能根据路径获取特定文档的完整内容(包括标题和章节)。
- 标准化通信: 通过Model Context Protocol (MCP) 标准化协议,以JSON-RPC格式与LLM客户端进行交互,提供结构化的上下文和功能调用。
- 自动重启与监控: 包含一个代理服务,用于监控Devkit MCP服务器,并在文件变更或服务器异常退出时自动重启,确保服务的稳定性和开发效率。
安装步骤
- 克隆仓库: 使用Git克隆TSEF项目仓库到本地。
git clone https://github.com/forepath/tsef.git - 进入项目目录:
cd tsef - 安装依赖: 安装项目所需的Node.js依赖。
npm install - 构建MCP服务器组件: 构建TSEF开发工具包MCP服务器及其代理服务。
此命令会构建'mcp-proxy'应用,并自动处理'mcp-devkit'的构建,因为'mcp-proxy'依赖于'mcp-devkit'的输出。npx nx run mcp-proxy:build --skip-nx-cache
服务器配置(MCP客户端使用)
MCP客户端需要以下JSON格式的配置信息来连接和使用TSEF开发工具包MCP服务器:
{ "name": "devkit", "description": "TSEF开发工具包MCP服务器,提供项目生成器和文档查询功能。", "command": "node", "args": [ "dist/apps/mcp-proxy/main.js" ], "env": { "MCP_DEVKIT_PATH": "dist/apps/mcp-devkit/main.js" }, "transport": "stdio" }
- 'name': MCP服务器的唯一标识符,此处为“devkit”。
- 'description': 服务器功能的简要说明,便于客户端理解其用途。
- 'command': 启动MCP服务器进程的命令行工具,通常是'node'。
- 'args': 传递给'command'的参数列表。这里指向的是已构建的'mcp-proxy'应用程序的主文件。'mcp-proxy'将作为真正的'mcp-devkit' MCP服务器的启动和管理入口。
- 'env': 环境变量,'MCP_DEVKIT_PATH'用于指定'mcp-proxy'内部实际启动的'mcp-devkit'服务器的路径。
- 'transport': 服务器与客户端通信的传输协议,这里采用标准输入输出('stdio')。
基本使用方法
TSEF Devkit MCP服务器主要供兼容MCP协议的LLM客户端或AI代理使用。启动后,客户端可以通过JSON-RPC协议发送请求来调用服务器提供的工具:
- 列出所有生成器: 客户端可以调用'devkit_list_generators'工具来获取当前TSEF工作空间中所有自定义Nx生成器的列表。
- 获取生成器详情: 客户端可以调用'devkit_get_generator'工具,并传入生成器名称作为参数,以获取其详细信息(如可用选项、描述)。
- 验证生成器选项: 客户端可以调用'devkit_validate_generator'工具,传入生成器名称和一组选项,服务器将验证这些选项的有效性,并返回一个预览命令。
- 列出文档: 客户端可以调用'devkit_list_docs'工具来获取'docs/'目录下所有Markdown文档的列表及其元数据。
- 获取文档内容: 客户端可以调用'devkit_get_doc'工具,并传入文档的相对路径,以获取该文档的完整Markdown内容、标题和章节。
信息
分类
开发者工具