mcpField
E
encore-go-getting-started

encore-go-getting-started

github.com/encoredev开发30533 次安装2 天前更新
代码仓库

关于 encore-go-getting-started

为使用 Encore Go 的 Agent 提供从检查 CLI、创建并运行应用到连接 MCP 服务的入门流程,并指引后续开发任务对应的技能。

主要功能

  1. 01检查并安装 Encore CLI
  2. 02登录或处理 CI 应用创建
  3. 03创建并验证 Encore Go 应用
  4. 04配置本地与云端 MCP 服务
  5. 05按开发任务加载后续技能

适用场景

  1. 01首次创建并运行 Encore Go 应用
  2. 02为编码 Agent 配置 Encore MCP 服务
  3. 03查找添加 API、数据库或测试的后续指引

MCP 相关

指导启动 Encore 本地 MCP 服务,并可在登录后配置 Encore Cloud MCP 服务,让工具检查和调用应用及读取部署信息。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/encoredev/skills --skill encore-go-getting-started

安装后在 Claude Code 中输入/encore-go-getting-started确认已加载。

详细介绍

设置 Encore Go

说明

本指南适用于 Encore Go。对于 Encore.ts,请使用 encore-getting-started。如果用户没有说明想使用哪种语言,请询问。

按顺序完成这些步骤。每个步骤都会说明如何确认操作成功。如果某个步骤失败,请加载该步骤指定的 skill。

1. 检查 CLI
encore version
  • **输出 encore version v...:**进入第 2 步。
  • **找不到命令:**安装它(encore-install),然后进入第 2 步。
2. 登录

如果用户只想在本地运行应用,可以跳过此步骤。

encore auth whoami
  • **logged in as <email>:**进入第 3 步。
  • **not logged in.:**在后台启动 encore auth login。将它输出的配对码和 URL 发给用户,并请用户在任意设备的浏览器中批准登录。等待出现 Successfully logged in!(encore-login)。
  • **logged in as app <app-id>,或者没有人可以批准登录(CI):**身份验证密钥无法创建应用。请用户在 Cloud Dashboard 中创建应用,然后运行 encore app clone <app-id>,进入该目录,并继续第 4 步。
3. 创建应用
encore app create my-app --example=hello-world
cd my-app
  • **以 Successfully created app my-app! 结束:**进入第 4 步。
  • **空应用:**对于不包含任何服务的应用,请改用 --example=empty,并跳过第 4 步。
  • **其他模板和错误:**请参阅 encore-create-app。
4. 检查应用能否运行
encore check 'curl /hello/world'
  • **输出 "Message": "Hello, world!" 并以状态码 0 退出:**进入第 5 步。
  • **失败:**请参阅 encore-run。

若要让应用持续运行以供用户使用,请在后台启动 encore run,切勿在前台运行(encore-run)。API 位于 http://localhost:4000,本地开发仪表板(包含每个请求的跟踪记录)位于 http://localhost:9400。

5. 连接 Encore 的 MCP 服务

这些 MCP 服务让你在构建应用时能够检查和调用应用,并在应用部署到 Encore Cloud 后读取其部署信息。如果用户创建应用时使用了 --llm-rules=<tool>,则可能已为该工具配置本地服务:请先检查,避免重复添加。

  1. **本地服务:**在应用根目录中运行 encore mcp start。它会输出 MCP stdio Command: encore mcp run --app=<app-id>。将该命令添加到用户的工具中。在 Claude Code 中:

    claude mcp add --transport stdio encore-local -- encore mcp run --app=<app-id>
    
  2. Encore Cloud 服务(仅当你在第 2 步登录时):

    claude mcp add --transport http --scope user encore-cloud https://api.encore.dev/mcp
    
  3. **Cursor、VS Code、其他工具,或改用 API 密钥而非登录:**请参阅 encore-mcp。

6. 汇报结果

设置已完成。请告知用户:

  • **应用所在位置:**应用目录;如果应用位于 Encore Cloud,还要提供其 Cloud Dashboard 页面:https://app.encore.dev/<app-id>。
  • **用户还需完成的操作:**工具会在重启时加载新的 MCP 服务。如果你添加了 encore-cloud,用户还需要对其进行一次身份验证:在 Claude Code 中输入 /mcp,选择 encore-cloud,然后选择 Authenticate。

要在应用上继续构建,请加载与任务对应的 skill。hello-world 应用包含一个服务:hello,位于 hello/ 中。

目标加载
添加端点、验证和错误处理encore-go-api
添加服务或从一个服务调用另一个服务encore-go-service
添加 SQL 数据库encore-go-database
要求登录后才能访问端点encore-go-auth
添加 Pub/Sub、定时任务、存储桶、密钥或缓存encore-go-pubsub、encore-go-cron、encore-go-bucket、encore-go-secret、encore-go-cache
编写测试encore-go-testing
部署:提交后运行 git push encoreencore-deploy

评论

支持 Markdown