get_install_guide

Instructions

Implementation Reference

• mcp_server/skill_store_mcp.py:409-438 (handler)

  The main handler function for the 'get_install_guide' tool. It calls the REST API endpoint /v1/skills/{skill_id}/install-guide with a platform parameter, then formats the response into a readable step-by-step installation guide string.

  def get_install_guide(skill_id: str, platform: str = "OpenClaw") -> str:
      """
      Get step-by-step installation instructions for a skill on a specific platform. / 플랫폼별 스킬 설치 가이드.
  
      Args:
          skill_id: 스킬 ID
          platform: 플랫폼 이름 - 'OpenClaw' | 'ClaudeCode' | 'ClaudeCodeAgentSkill' | 'CustomAgent' | 'Cursor' | 'GeminiCLI' | 'CodexCLI'
  
      Returns:
          단계별 설치 가이드 문자열
      """
      result = _get(f"/v1/skills/{skill_id}/install-guide", {"platform": platform})
      if result.get("status") == "error":
          return f"오류: {result.get('message')}"
  
      steps = result.get("steps", [])
      lines = [
          f"📋 [{platform}] 설치 가이드 — {result.get('skill_name', skill_id)}",
          f"설정 파일 경로: {result.get('config_path', 'N/A')}",
          "",
          "설치 단계:",
      ]
      for i, step in enumerate(steps, 1):
          if isinstance(step, dict):
              lines.append(f"  {i}. {step.get('description', step)}")
              if step.get("command"):
                  lines.append(f"     $ {step['command']}")
          else:
              lines.append(f"  {i}. {step}")
      return "\n".join(lines)

• mcp_server/skill_store_mcp.py:407-438 (registration)

  The tool is registered with MCP via the @mcp.tool() decorator on the get_install_guide function. The FastMCP instance 'mcp' is created at line 60-80.

  @mcp.tool()
  @_log_tool
  def get_install_guide(skill_id: str, platform: str = "OpenClaw") -> str:
      """
      Get step-by-step installation instructions for a skill on a specific platform. / 플랫폼별 스킬 설치 가이드.
  
      Args:
          skill_id: 스킬 ID
          platform: 플랫폼 이름 - 'OpenClaw' | 'ClaudeCode' | 'ClaudeCodeAgentSkill' | 'CustomAgent' | 'Cursor' | 'GeminiCLI' | 'CodexCLI'
  
      Returns:
          단계별 설치 가이드 문자열
      """
      result = _get(f"/v1/skills/{skill_id}/install-guide", {"platform": platform})
      if result.get("status") == "error":
          return f"오류: {result.get('message')}"
  
      steps = result.get("steps", [])
      lines = [
          f"📋 [{platform}] 설치 가이드 — {result.get('skill_name', skill_id)}",
          f"설정 파일 경로: {result.get('config_path', 'N/A')}",
          "",
          "설치 단계:",
      ]
      for i, step in enumerate(steps, 1):
          if isinstance(step, dict):
              lines.append(f"  {i}. {step.get('description', step)}")
              if step.get("command"):
                  lines.append(f"     $ {step['command']}")
          else:
              lines.append(f"  {i}. {step}")
      return "\n".join(lines)

• mcp_server/skill_store_mcp.py:85-95 (helper)

  The _get helper function is used by get_install_guide to make the REST API call to the Skill Store backend. It sends an HTTP GET with URL-encoded params and returns parsed JSON.

  def _get(path: str, params: dict = None) -> dict:
      url = SKILL_STORE_URL + path
      if params:
          url += "?" + urllib.parse.urlencode({k: v for k, v in params.items() if v is not None})
      try:
          with urllib.request.urlopen(url, timeout=10) as resp:
              return json.loads(resp.read().decode())
      except urllib.error.HTTPError as e:
          return {"status": "error", "message": f"HTTP {e.code}: {e.reason}"}
      except Exception as e:
          return {"status": "error", "message": str(e)}

• mcp_server/skill_store_mcp.py:409-419 (schema)

  The input schema is defined via function signature: skill_id (str, required) and platform (str, optional, default 'OpenClaw'). The valid platform values are documented in the docstring: OpenClaw, ClaudeCode, ClaudeCodeAgentSkill, CustomAgent, Cursor, GeminiCLI, CodexCLI. Return type is str.

  def get_install_guide(skill_id: str, platform: str = "OpenClaw") -> str:
      """
      Get step-by-step installation instructions for a skill on a specific platform. / 플랫폼별 스킬 설치 가이드.
  
      Args:
          skill_id: 스킬 ID
          platform: 플랫폼 이름 - 'OpenClaw' | 'ClaudeCode' | 'ClaudeCodeAgentSkill' | 'CustomAgent' | 'Cursor' | 'GeminiCLI' | 'CodexCLI'
  
      Returns:
          단계별 설치 가이드 문자열
      """