bkend-quickstart

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

bkend.ai Quick Start Guide

bkend.ai 快速开始指南

What is bkend.ai

什么是 bkend.ai

MCP-based BaaS platform providing Database, Authentication, and Storage services. Manage backend via natural language from AI tools (Claude Code, Cursor).
基于MCP的BaaS平台,提供数据库、认证与存储服务。 可通过AI工具(Claude Code、Cursor)以自然语言管理后端。

Resource Hierarchy

资源层级

Organization (team/billing) -> Project (service unit) -> Environment (dev/staging/prod, data isolation)
Organization (团队/计费) -> Project (服务单元) -> Environment (开发/预发布/生产,数据隔离)

Tenant vs User

租户 vs 用户

  • Tenant: Service builder (OAuth 2.1 auth, MCP/Management API access)
  • User: App end-user (JWT auth, Service API access)
  • One person can have both roles
  • Tenant(租户):服务构建者(采用OAuth 2.1认证,可访问MCP/管理API)
  • User(用户):应用终端用户(采用JWT认证,可访问服务API)
  • 同一人可同时拥有两种角色

MCP Setup (Claude Code)

MCP 设置(Claude Code)

Quick Setup (One Command)

快速设置(一键命令)

bash
claude mcp add bkend --transport http https://api.bkend.ai/mcp
bash
claude mcp add bkend --transport http https://api.bkend.ai/mcp

Step-by-Step Guide

分步指南

  1. Prerequisites: bkend.ai account (signup at https://console.bkend.ai)
  2. Run setup command:
    claude mcp add bkend --transport http https://api.bkend.ai/mcp
  3. OAuth authentication: Browser auto-opens for OAuth 2.1 + PKCE auth (no API key needed)
  4. Verify connection: Ask "Show my connected bkend projects" or use
    0_get_context
    MCP tool
  5. Create .mcp.json (optional, for team sharing):
    json
    {
      "mcpServers": {
        "bkend": {
          "type": "http",
          "url": "https://api.bkend.ai/mcp"
        }
      }
    }
  1. 前置条件:拥有bkend.ai账号(可在https://console.bkend.ai注册)
  2. 运行设置命令
    claude mcp add bkend --transport http https://api.bkend.ai/mcp
  3. OAuth认证:浏览器将自动打开,进行OAuth 2.1 + PKCE认证(无需API密钥)
  4. 验证连接:可询问“显示我已连接的bkend项目”或使用
    0_get_context
    MCP工具
  5. 创建.mcp.json文件(可选,用于团队共享):
    json
    {
      "mcpServers": {
        "bkend": {
          "type": "http",
          "url": "https://api.bkend.ai/mcp"
        }
      }
    }

Troubleshooting MCP Connection

MCP连接故障排查

ProblemSolution
OAuth popup not appearingCheck browser popup blocker
MCP tools not visibleRun
claude mcp list
to verify, re-add if needed
Connection lostRe-authenticate (automatic on next MCP call)
Wrong project/envUse
0_get_context
to check current session
问题解决方案
OAuth弹窗未出现检查浏览器弹窗拦截设置
MCP工具不可见运行
claude mcp list
命令验证,若需则重新添加
连接丢失重新认证(下次调用MCP时将自动触发)
项目/环境错误使用
0_get_context
工具检查当前会话

MCP Guide Tools (No Parameters)

MCP指南工具(无参数)

ToolPurpose
0_get_contextSession context (org/project/env)
1_conceptsCore concepts (BSON, permissions, hierarchy)
2_tutorialProject~table creation tutorial
工具用途
0_get_context查看会话上下文(组织/项目/环境)
1_concepts查看核心概念(BSON、权限、层级结构)
2_tutorial项目~表创建教程

First Project Checklist

首个项目检查清单

  1. Sign up at bkend.ai -> Create Organization
  2. Create Project -> dev environment auto-created
  3. Connect MCP ->
    claude mcp add bkend
  4. Create first table -> "Create a users table"
  5. Start data operations -> CRUD via natural language
  1. 在bkend.ai注册账号 → 创建组织
  2. 创建项目 → 自动生成开发环境
  3. 连接MCP → 运行
    claude mcp add bkend
    命令
  4. 创建首个数据表 → 输入“创建一个users表”
  5. 开始数据操作 → 通过自然语言进行CRUD操作

Console URL

控制台地址

https://console.bkend.ai
https://console.bkend.ai

Next Steps

后续步骤

  • Database operations: refer to bkend-data skill
  • Authentication: refer to bkend-auth skill
  • File storage: refer to bkend-storage skill
  • Practical tutorials: refer to bkend-cookbook skill
  • 数据库操作:参考bkend-data技能
  • 认证操作:参考bkend-auth技能
  • 文件存储:参考bkend-storage技能
  • 实用教程:参考bkend-cookbook技能

Official Documentation (Live Reference)

官方文档(实时参考)