MCPcopy
hub / github.com/coze-dev/coze-studio

github.com/coze-dev/coze-studio @v0.5.1 sqlite

repository ↗ · DeepWiki ↗ · release v0.5.1 ↗
89,102 symbols 188,553 edges 10,721 files 6,988 documented · 8%
README

Image

Coze Studio功能清单快速开始开发指南

License Go Version

English | 中文

什么是 Coze Studio

Coze Studio 是一站式 AI Agent 开发工具。提供各类最新大模型和工具、多种开发模式和框架,从开发到部署,为你提供最便捷的 AI Agent 开发环境。

  • 提供 AI Agent 开发所需的全部核心技术:Prompt、RAG、Plugin、Workflow,使得开发者可以聚焦创造 AI 核心价值。
  • 开箱即用,用最低的成本开发最专业的 AI Agent:Coze Studio 为开发者提供了健全的应用模板和编排框架,你可以基于它们快速构建各种 AI Agent ,将创意变为现实。

Coze Studio,源自服务了上万家企业、数百万开发者的「扣子开发平台」,我们将它的核心引擎完全开放。它是一个一站式的 AI Agent 可视化开发工具,让 AI Agent 的创建、调试和部署变得前所未有的简单。通过 Coze Studio 提供的可视化设计与编排工具,开发者可以通过零代码或低代码的方式,快速打造和调试智能体、应用和工作流,实现强大的 AI 应用开发和更多定制化业务逻辑,是构建低代码 AI 产品的理想选择。Coze Studio 致力于降低 AI Agent 开发与应用门槛,鼓励社区共建和分享交流,助你在 AI 领域进行更深层次的探索与实践。

Coze Studio 的后端采用 Golang 开发,前端使用 React + TypeScript,整体基于微服务架构并遵循领域驱动设计(DDD)原则构建。为开发者提供一个高性能、高扩展性、易于二次开发的底层框架,助力开发者应对复杂的业务需求。

功能清单

功能模块 功能点
模型服务 管理模型列表,可接入OpenAI、火山方舟 等在线或离线模型服务
搭建智能体 * 编排、发布、管理智能体
  • 支持配置工作流、知识库等资源 | | 搭建应用 | * 创建、发布应用

  • 通过工作流搭建业务逻辑 | | 搭建工作流 | 创建、修改、发布、删除工作流 | | 开发资源 | 支持创建并管理以下资源:

  • 插件

  • 知识库

  • 数据库

  • 提示词 | | API 与 SDK | * 创建会话、发起对话等 OpenAPI

  • 通过 Chat SDK 将智能体或应用集成到自己的应用 |

快速开始

了解如何获取并部署 Coze Studio 开源版,快速构建项目、体验 Coze Studio 开源版。

环境要求:

  • 在安装 Coze Studio 之前,请确保您的机器满足以下最低系统要求: 2 Core、4 GB
  • 提前安装 Docker、Docker Compose,并启动 Docker 服务。

部署步骤:

  1. 获取源码。

Bash # 克隆代码 git clone https://github.com/coze-dev/coze-studio.git

  1. 部署并启动服务。 首次部署并启动 Coze Studio 需要拉取镜像、构建本地镜像,可能耗时较久,请耐心等待。如果看到提示 "Container coze-server Started",表示 Coze Studio 服务已成功启动。

Bash cd coze-studio # start service # for macOS or Linux make web # for windows cp ./docker/.env.example ./docker/.env docker compose -f ./docker/docker-compose.yml up

启动失败常见问题可参考常见问题。 3. 注册账号,访问 http://localhost:8888/sign 输入用户名、密码点击注册按钮。 4. 配置模型:访问 http://localhost:8888/admin/#model-management 新增模型。(镜像版本需要大于等于 0.5.0)。 5. 访问 Coze Studio http://localhost:8888/

[!WARNING] 如果要将 Coze Studio 部署到公网环境,建议在部署前评估整体评估安全风险,例如账号注册功能、工作流代码节点 Python执行环境、Coze Server 监听地址配置、SSRF 和部分 API 水平越权的风险,并采取相应防护措施。详细信息可参考快速开始

开发指南

  • 项目配置
  • 模型配置:部署 Coze Studio 开源版之前,必须配置模型服务,否则无法在搭建智能体、工作流和应用时选择模型。
  • 插件配置:如需使用插件商店中的官方插件,必须先配置插件,添加第三方服务的鉴权秘钥。
  • 基础组件配置:了解如何配置图片上传等组件,以便在 Coze Studio 中使用上传图片等功能。
  • API 参考:Coze Studio 社区版 API 和 Chat SDK 通过个人访问令牌鉴权,提供对话和工作流相关 API。
  • 开发规范
  • 项目架构:了解 Coze Studio 开源版的技术架构与核心组件。
  • 代码开发与测试:了解如何基于 Coze Studio 开源版进行二次开发与测试。
  • 故障排查:了解如何查看容器状态、系统日志。

使用 Coze Studio 开源版

关于如何使用 Coze Studio,可参考扣子开发平台官方文档中心获取更多资料。需要注意的是,音色等部分功能限商业版本使用,开源版与商业版的功能差异可参考功能清单

  • 快速入门:通过 Coze Studio 快速搭建一个 AI 助手智能体。
  • 开发智能体:如何创建、编排、发布与管理智能体。你可以使用知识、插件等功能解决模型幻觉、专业领域知识不足等问题。除此之外,Coze Studio 还提供了丰富的记忆功能,使智能体在与个人用户交互时,可根据个人用户的历史对话等生成更准确性的回复。
  • 开发工作流:工作流是一系列可执行指令的集合,用于实现业务逻辑或完成特定任务。它为应用/智能体的数据流动和任务处理提供了一个结构化框架。 Coze Studio 提供了一个可视化画布,你可以通过拖拽节点迅速搭建工作流。
  • 插件等资源:在 Coze Studio,工作流、插件、数据库、知识库和变量统称为资源。
  • API & SDK: Coze Studio 支持对话和工作流相关 API,你也可以通过 Chat SDK 将智能体或应用集成到本地业务系统。
  • 实践教程:了解如何通过 Coze Studio 实现各种 AI 场景,例如通过 Chat SDK 搭建网页在线客服。

License

本项目采用 Apache 2.0 许可证。详情请参阅 LICENSE 文件。

社区贡献

我们欢迎社区贡献,贡献指南参见 CONTRIBUTINGCode of conduct,期待您的贡献!

安全与隐私

如果你在该项目中发现潜在的安全问题,或你认为可能发现了安全问题,请通过我们的安全中心漏洞报告邮箱通知字节跳动安全团队。 请不要创建公开的 GitHub Issue。

加入社区

我们致力于构建一个开放、友好的开发者社区,欢迎所有对 AI Agent 开发感兴趣的开发者加入我们!

🐛 问题反馈与功能建议

为了更高效地跟踪和解决问题,保证信息透明和便于协同,我们推荐通过以下方式参与: - GitHub Issues提交 Bug 报告或功能请求 - Pull Requests贡献代码或文档改进

💬 技术交流与讨论

加入我们的技术交流群,与其他开发者分享经验、获取项目最新动态:

飞书群聊
使用飞书移动端扫描下方二维码加入:

Image

Discord 服务器
点击加入:Coze Community

Telegram 群组
点击加入:Telegram Group Coze

致谢

感谢所有为 Coze Studio 项目做出贡献的开发者和社区成员。特别感谢:

  • Eino 框架团队 - 为 Coze Studio 的智能体和工作流运行时、模型抽象封装、知识库索引构建和检索提供了强大的支持
  • FlowGram 团队 - 为 Coze Studio 的工作流画布编辑页提供了高质量的流程搭建引擎
  • Hertz 团队 - 高性能、强扩展性的 Go HTTP 框架,用于构建微服务
  • 所有参与测试和反馈的用户

Extension points exported contracts — how you extend this code

ImageX (Interface)
go:generate mockgen -destination ../../internal/mock/infra/imagex/imagex_mock.go --package imagex -source imagex.go [6 …
backend/infra/imagex/imagex.go
Uploader (Interface)
go:generate mockgen -destination uploadmock/upload_mock.go --package uploadmock -source upload.go [8 implementers]
backend/crossdomain/upload/contract.go
TemplateRepository (Interface)
TemplateRepository defines the interface for template operations [28 implementers]
backend/domain/template/repository/repository.go
Plugin (Interface)
(no doc) [27 implementers]
frontend/packages/arch/tea-interface/src/index.ts
IPlugin (Interface)
(no doc) [21 implementers]
frontend/infra/idl/idl2ts-plugin/src/program.ts
FormatLogger (Interface)
FormatLogger is a logs interface that output logs with a format. [1 implementers]
backend/pkg/logs/logger.go
ResourcePacker (Interface)
(no doc) [3 implementers]
backend/application/search/resource_pack.go
MemoryService (Interface)
(no doc) [2 implementers]
backend/api/model/data/variable/variable_svc.go

Core symbols most depended-on inside this repo

t
called by 6151
frontend/packages/arch/i18n/src/index.ts
request
called by 3765
backend/pkg/saasapi/client.go
Errorf
called by 2301
backend/pkg/logs/logger.go
map
called by 1795
frontend/infra/idl/idl2ts-generator/src/type-mapper.ts
Error
called by 1166
backend/pkg/logs/logger.go
filter
called by 821
frontend/packages/project-ide/framework/src/plugins/create-preset-plugin/project-ide-services.ts
push
called by 773
frontend/packages/project-ide/view/src/shell/layout-restorer.ts
find
called by 601
backend/domain/workflow/internal/nodes/emitter/emitter.go

Shape

Method 45,059
Interface 18,705
Function 15,457
Enum 4,859
Struct 3,461
Class 1,069
TypeAlias 454
FuncType 38

Languages

Go53%
TypeScript47%
Python1%

Modules by API surface

backend/api/model/workflow/workflow.go5,296 symbols
backend/api/model/app/developer_api/developer_api.go2,388 symbols
backend/api/model/plugin_develop/plugin_develop.go2,282 symbols
backend/api/model/marketplace/product_public_api/public_api.go2,202 symbols
backend/api/model/app/bot_common/bot_common.go2,201 symbols
backend/api/model/data/database/table/table.go2,130 symbols
backend/api/model/playground/playground.go1,429 symbols
backend/api/model/workflow/workflow_svc.go1,188 symbols
frontend/packages/arch/idl/src/auto-generated/playground_api/namespaces/playground.ts948 symbols
backend/api/model/admin/config/config.go938 symbols
backend/api/model/data/knowledge/knowledge_svc.go876 symbols
frontend/packages/arch/idl/src/auto-generated/developer_api/namespaces/developer_api.ts854 symbols

Dependencies from manifests, versioned

cloud.google.com/gov0.118.3 · 1×
cloud.google.com/go/authv0.15.0 · 1×
cloud.google.com/go/compute/metadatav0.6.0 · 1×
filippo.io/edwards25519v1.1.0 · 1×
github.com/99designs/go-keychainv0.0.0-2019100805025 · 1×
github.com/99designs/keyringv1.2.1 · 1×
github.com/AthenZ/athenzv1.12.13 · 1×
github.com/DATA-DOG/go-sqlmockv1.5.2 · 1×
github.com/DataDog/zstdv1.5.0 · 1×
github.com/IBM/saramav1.45.1 · 1×
github.com/alicebob/gopher-jsonv0.0.0-2023021814350 · 1×
github.com/alicebob/miniredis/v2v2.34.0 · 1×

Datastores touched

(mysql)Database · 1 repos
opencozeDatabase · 1 repos

For agents

$ claude mcp add coze-studio \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact