Files
FastGPT/CLAUDE.md
Archer e25d7efb5b feature: V4.11.1 (#5350)
* perf: system toolset & mcp (#5200)

* feat: support system toolset

* fix: type

* fix: system tool config

* chore: mcptool config migrate

* refactor: mcp toolset

* fix: fe type error

* fix: type error

* fix: show version

* chore: support extract tool's secretInputConfig out of inputs

* chore: compatible with old version mcp

* chore: adjust

* deps: update dependency @fastgpt-skd/plugin

* fix: version

* fix: some bug (#5316)

* chore: compatible with old version mcp

* fix: version

* fix: compatible bug

* fix: mcp object params

* fix: type error

* chore: update test cases

* chore: remove log

* fix: toolset node name

* optimize app logs sort (#5310)

* log keys config modal

* multiple select

* api

* fontsize

* code

* chatid

* fix build

* fix

* fix component

* change name

* log keys config

* fix

* delete unused

* fix

* perf: log code

* perf: send auth code modal enter press

* fix log (#5328)

* perf: mcp toolset comment

* perf: log ui

* remove log (#5347)

* doc

* fix: action

* remove log

* fix: Table Optimization (#5319)

* feat: table test: 1

* feat: table test: 2

* feat: table test: 3

* feat: table test: 4

* feat: table test : 5 把maxSize改回chunkSize

* feat: table test : 6 都删了,只看maxSize

* feat: table test : 7 恢复初始,接下来删除标签功能

* feat: table test : 8 删除标签功能

* feat: table test : 9 删除标签功能成功

* feat: table test : 10 继续调试,修改trainingStates

* feat: table test : 11 修改第一步

* feat: table test : 12 修改第二步

* feat: table test : 13 修改了HtmlTable2Md

* feat: table test : 14 修改表头分块规则

* feat: table test : 15 前面表格分的太细了

* feat: table test : 16 改着改着表头又不加了

* feat: table test : 17 用CUSTOM_SPLIT_SIGN不行,重新改

* feat: table test : 18 表头仍然还会多加,但现在分块搞的合理了终于

* feat: table test : 19 还是需要搞好表头问题,先保存一下调试情况

* feat: table test : 20 调试结束,看一下replace有没有问题,没问题就pr

* feat: table test : 21 先把注释删了

* feat: table test : 21 注释replace都改了,下面切main分支看看情况

* feat: table test : 22 修改旧文件

* feat: table test : 23 修改测试文件

* feat: table test : 24 xlsx表格处理

* feat: table test : 25 刚才没保存先com了

* feat: table test : 26 fix

* feat: table test : 27 先com一版调试

* feat: table test : 28 试试放format2csv里

* feat: table test : 29 xlsx解决

* feat: table test : 30 tablesplit解决

* feat: table test : 31

* feat: table test : 32

* perf: table split

* perf: mcp old version compatibility (#5342)

* fix: system-tool secret inputs

* fix: rewrite runtime node i18n for system tool

* perf: mcp old version compatibility

* fix: splitPluginId

* fix: old mcp toolId

* fix: filter secret key

* feat: support system toolset activation

* chore: remove log

* perf: mcp update

* perf: rewrite toolset

* fix:delete variable id (#5335)

* perf: variable update

* fix: multiple select ui

* perf: model config move to plugin

* fix: var conflit

* perf: variable checker

* Avoid empty number

* update doc time

* fix: test

* fix: mcp object

* update count app

* update count app

---------

Co-authored-by: Finley Ge <32237950+FinleyGe@users.noreply.github.com>
Co-authored-by: heheer <heheer@sealos.io>
Co-authored-by: heheer <zhiyu44@qq.com>
Co-authored-by: colnii <1286949794@qq.com>
Co-authored-by: dreamer6680 <1468683855@qq.com>
2025-08-01 16:08:20 +08:00

4.8 KiB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

FastGPT is an AI Agent construction platform providing out-of-the-box data processing, model invocation capabilities, and visual workflow orchestration through Flow. This is a full-stack TypeScript application built on NextJS with MongoDB/PostgreSQL backends.

Tech Stack: NextJS + TypeScript + ChakraUI + MongoDB + PostgreSQL (PG Vector)/Milvus

Architecture

This is a monorepo using pnpm workspaces with the following key structure:

Packages (Library Code)

  • packages/global/ - Shared types, constants, utilities used across all projects
  • packages/service/ - Backend services, database schemas, API controllers, workflow engine
  • packages/web/ - Shared frontend components, hooks, styles, i18n
  • packages/templates/ - Application templates for the template market

Projects (Applications)

  • projects/app/ - Main NextJS web application (frontend + API routes)
  • projects/sandbox/ - NestJS code execution sandbox service
  • projects/mcp_server/ - Model Context Protocol server implementation

Key Directories

  • document/ - Documentation site (NextJS app with content)
  • plugins/ - External plugins (models, crawlers, etc.)
  • deploy/ - Docker and Helm deployment configurations
  • test/ - Centralized test files and utilities

Development Commands

Main Commands (run from project root)

  • pnpm dev - Start development for all projects (uses package.json workspace scripts)
  • pnpm build - Build all projects
  • pnpm test - Run tests using Vitest
  • pnpm test:workflow - Run workflow-specific tests
  • pnpm lint - Run ESLint across all TypeScript files with auto-fix
  • pnpm format-code - Format code using Prettier

Project-Specific Commands

Main App (projects/app/):

  • cd projects/app && pnpm dev - Start NextJS dev server
  • cd projects/app && pnpm build - Build NextJS app
  • cd projects/app && pnpm start - Start production server

Sandbox (projects/sandbox/):

  • cd projects/sandbox && pnpm dev - Start NestJS dev server with watch mode
  • cd projects/sandbox && pnpm build - Build NestJS app
  • cd projects/sandbox && pnpm test - Run Jest tests

MCP Server (projects/mcp_server/):

  • cd projects/mcp_server && bun dev - Start with Bun in watch mode
  • cd projects/mcp_server && bun build - Build MCP server
  • cd projects/mcp_server && bun start - Start MCP server

Utility Commands

  • pnpm create:i18n - Generate i18n translation files
  • pnpm api:gen - Generate OpenAPI documentation
  • pnpm initIcon - Initialize icon assets
  • pnpm gen:theme-typings - Generate Chakra UI theme typings

Testing

The project uses Vitest for testing with coverage reporting. Key test commands:

  • pnpm test - Run all tests
  • pnpm test:workflow - Run workflow tests specifically
  • Test files are located in test/ directory and projects/app/test/
  • Coverage reports are generated in coverage/ directory

Code Organization Patterns

Monorepo Structure

  • Shared code lives in packages/ and is imported using workspace references
  • Each project in projects/ is a standalone application
  • Use @fastgpt/global, @fastgpt/service, @fastgpt/web imports for shared packages

API Structure

  • NextJS API routes in projects/app/src/pages/api/
  • Core business logic in packages/service/core/
  • Database schemas in packages/service/ with MongoDB/Mongoose

Frontend Architecture

  • React components in projects/app/src/components/ and packages/web/components/
  • Chakra UI for styling with custom theme in packages/web/styles/theme.ts
  • i18n support with files in packages/web/i18n/
  • State management using React Context and Zustand

Workflow System

  • Visual workflow editor using ReactFlow
  • Workflow engine in packages/service/core/workflow/
  • Node definitions in packages/global/core/workflow/template/
  • Dispatch system for executing workflow nodes

Development Notes

  • Package Manager: Uses pnpm with workspace configuration
  • Node Version: Requires Node.js >=18.16.0, pnpm >=9.0.0
  • Database: Supports MongoDB, PostgreSQL with pgvector, or Milvus for vector storage
  • AI Integration: Supports multiple AI providers through unified interface
  • Internationalization: Full i18n support for Chinese, English, and Japanese

Key File Patterns

  • .ts and .tsx files use TypeScript throughout
  • Database schemas use Mongoose with TypeScript
  • API routes follow NextJS conventions
  • Component files use React functional components with hooks
  • Shared types defined in packages/global/ with .d.ts files

Environment Configuration

  • Configuration files in projects/app/data/config.json
  • Environment-specific configs supported
  • Model configurations in packages/service/core/ai/config/