register

Instructions

Implementation Reference

• client-extension/openaaas-mcp-adapter/src/openaaas_mcp_adapter/tools.py:352-431 (handler)

  The MCP tool handler for 'register'. It is decorated with @mcp.tool() and defines the register function that: validates the name parameter, checks for existing registration, calls POST /api/v1/client/auth/register on the server, saves the api_key to config, and returns a success/error message.

  # ------------------------------------------------------------------
  @mcp.tool()
  def register(name: str, server: str = "default") -> str:
      """注册客户端账号，获取 api_key（仅需一次）"""
      name = name.strip()
      if not name:
          return "❌ 缺少必填参数: name"
      if len(name) > 64:
          return "❌ 参数错误: name 长度不能超过 64 字符"
      if re.search(r'[\x00-\x1f/\\<>|&;$]', name):
          return "❌ 参数错误: name 包含非法字符"
      if any(unicodedata.category(c).startswith('C') for c in name):
          return "❌ 参数错误: name 包含非法字符（Unicode 控制字符）"
  
      try:
          sc = get_server_config(server)
      except RuntimeError as e:
          return f"❌ {e}"
  
      alias = sc["alias"]
      server_url = strip_trailing_slash(sc.get("server_url", ""))
      if not server_url:
          return "❌ 服务器地址未配置，请先使用 set_server_url 设置"
  
      # 已注册检查
      if sc.get("api_key"):
          return (
              f"✅ 已注册，无需重复注册。\n"
              f"服务器别名: {alias}\n"
              f"服务器地址: {server_url}\n"
              f"客户端 ID: {sc.get('client_id', 'unknown')}\n"
              f"用户名: {sc.get('name', 'unknown')}\n\n"
              "如需修改用户名，请使用 update_profile。\n"
              "如需切换到其他服务器，请先用 set_server_url 修改地址，再重新注册。"
          )
  
      # 检查其他 alias 是否已用相同 URL 注册
      config = load_config()
      for other_alias, other_srv in config.get("servers", {}).items():
          if other_alias == alias:
              continue
          other_url = strip_trailing_slash(other_srv.get("server_url", ""))
          if other_url == server_url and other_srv.get("api_key"):
              return (
                  "❌ 该服务器地址已被其他别名注册过。\n"
                  f"服务器别名: {other_alias}\n"
                  f"服务器地址: {other_srv.get('server_url')}\n"
                  f"客户端 ID: {other_srv.get('client_id', 'unknown')}\n"
                  f"用户名: {other_srv.get('name', 'unknown')}\n\n"
                  "如需使用其他别名，请先使用 remove_server 删除已有配置。"
              )
  
      url = f"{server_url}/api/v1/client/auth/register"
      try:
          result = safe_request("POST", url, data={"name": name})
      except OpenAaaSError as e:
          return f"❌ 注册失败: {e}"
  
      api_key = result.get("api_key") or result.get("token")
      client_id = result.get("client_id") or result.get("id")
  
      if api_key:
          config = load_config()
          servers = config.setdefault("servers", {})
          if alias not in servers:
              servers[alias] = {}
          servers[alias]["api_key"] = api_key
          if client_id:
              servers[alias]["client_id"] = client_id
          servers[alias]["name"] = name
          servers[alias]["server_url"] = server_url
          save_config(config)
          saved = True
      else:
          saved = False
  
      return (
          f"✅ 注册成功！服务器: {alias}，客户端 ID: {client_id}。\n"
          f"API Key 已{'自动保存' if saved else '返回，请手动保存'}到 config.json"
      )

• client-extension/openaaas-mcp-adapter/src/openaaas_mcp_adapter/tools.py:353-354 (schema)

  Input schema for the register tool: parameters are 'name' (str, required) and 'server' (str, default='default'), validated inline (non-empty, max 64 chars, no illegal chars).

  @mcp.tool()
  def register(name: str, server: str = "default") -> str:

• client-extension/openaaas-mcp-adapter/src/openaaas_mcp_adapter/__main__.py:1-8 (registration)

  The entry point that creates a FastMCP instance and calls register_tools(mcp), which registers all tools including 'register'.

  import sys
  from fastmcp import FastMCP
  from .tools import register_tools
  
  
  def main() -> None:
      mcp = FastMCP("openaaas-mcp-adapter")
      register_tools(mcp)

• client-extension/openaaas-mcp-adapter/src/openaaas_mcp_adapter/tools.py:225-227 (registration)

  The register_tools function itself, which is called from __main__.py to register all MCP tools on the FastMCP instance.

  def register_tools(mcp: FastMCP) -> None:
      """注册所有 OpenAaaS MCP Tools"""

• client-app/src/stores/server.ts:199-199 (registration)

  Export of the register function in the client-app Vue store (server.ts). This is a frontend register function that calls the same API endpoint.

  register,