Copilot SDK हार्नेस

​

आवश्यकताएँ

• OpenClaw जिसमें @openclaw/copilot Plugin स्थापित हो।
• यदि आपका config plugins.allow का उपयोग करता है, तो copilot शामिल करें (Plugin द्वारा घोषित manifest id)। एक restrictive allowlist जो npm-style @openclaw/copilot package name का उपयोग करती है, Plugin को blocked छोड़ देगी और runtime load नहीं होगा, भले ही agentRuntime.id: "copilot" हो।
• एक GitHub Copilot subscription जो Copilot CLI को drive कर सके (या headless / cron runs के लिए gitHubToken env / auth-profile entry)।
• writable copilotHome directory। जब OpenClaw agent directory प्रदान करता है, तो हार्नेस default रूप से <agentDir>/copilot का उपयोग करता है, अन्यथा full per-agent isolation के लिए ~/.openclaw/agents/<agentId>/copilot का।

​

Plugin स्थापना

openclaw plugins install @openclaw/copilot

1. installed @openclaw/copilot package से import("@github/copilot-sdk")।
2. well-known fallback dir ~/.openclaw/npm-runtime/copilot/ (legacy on-demand install target)।

​

त्वरित प्रारंभ

{
  agents: {
    defaults: {
      model: "github-copilot/auto",
      models: {
        "github-copilot/auto": {
          agentRuntime: { id: "copilot" },
        },
      },
    },
  },
}

​

समर्थित providers

• github-copilot

• openai-responses
• openai-completions
• ollama (OpenAI-compatible completions)
• azure-openai-responses
• anthropic-messages

​

BYOK

{
  agents: {
    defaults: {
      model: "custom-proxy/llama-3.1-8b",
      models: {
        "custom-proxy/llama-3.1-8b": {
          agentRuntime: { id: "copilot" },
        },
      },
    },
  },
  models: {
    mode: "merge",
    providers: {
      "custom-proxy": {
        baseUrl: "https://api.example.com/v1",
        apiKey: "${CUSTOM_PROXY_API_KEY}",
        api: "openai-responses",
        authHeader: true,
        models: [{ id: "llama-3.1-8b", name: "Llama 3.1 8B" }],
      },
    },
  },
}

​

प्रमाणीकरण

1. Attempt input पर Explicit useLoggedInUser: true। Agent के copilotHome के अंतर्गत resolved Copilot CLI के logged-in user का उपयोग करता है।
2. Attempt input पर Explicit gitHubToken (profileId + profileVersion के साथ)। Direct CLI invocations और tests के लिए उपयोगी, जहाँ caller auth-profile resolution को bypass करना चाहता है।
3. EmbeddedRunAttemptParams shape से Contract-resolved resolvedApiKey + authProfileId। यह production main path है: core, हार्नेस invoke करने से पहले agent के configured github-copilot auth profile को (via src/infra/provider-usage.auth.ts:resolveProviderAuths) resolve करता है, और हार्नेस दोनों fields को सीधे consume करता है। इससे github-copilot:<profile> auth profile headless / cron / multi-profile setups के लिए env vars के बिना end-to-end काम करता है।
4. Direct CLI / dogfood runs के लिए Env-var fallback जहाँ कोई auth profile configured नहीं है। Runtime निम्न vars को precedence order में check करता है, shipped github-copilot provider (extensions/github-copilot/auth.ts) और documented Copilot SDK setup को mirror करते हुए:
   1. OPENCLAW_GITHUB_TOKEN — harness-specific override; इसे OpenClaw हार्नेस के लिए token pin करने हेतु set करें, बिना system-wide gh / Copilot CLI config को disturb किए।
   2. COPILOT_GITHUB_TOKEN — standard Copilot SDK / CLI env var।
   3. GH_TOKEN — standard gh CLI env var (existing github-copilot provider precedence से match करता है)।
   4. GITHUB_TOKEN — generic GitHub token fallback।
   पहला non-empty value जीतता है; empty strings को absent माना जाता है। Synthesised pool profile id env:<NAME> है और profileVersion token का non-reversible sha256 fingerprint है, इसलिए env value rotate करने से client pool cleanly bust होता है।
5. कोई token signal उपलब्ध न होने पर Default useLoggedInUser।

​

कॉन्फ़िगरेशन सतह

• copilotHome — per-agent CLI state directory (defaults ऊपर documented हैं)।
• model — string या { provider, id, api?, baseUrl?, headers?, authHeader? }। Omitted होने पर, OpenClaw agent के normal model selection का उपयोग करता है और हार्नेस verify करता है कि resolved provider supported है।
• reasoningEffort — "low" | "medium" | "high" | "xhigh"। auto-reply/thinking.ts में OpenClaw के ThinkLevel / ReasoningLevel resolution से map करता है।
• infiniteSessionConfig — SDK infiniteSessions block के लिए optional override जो harness.compact द्वारा driven है। Defaults को as-is छोड़ना safe है।
• hooksConfig — tool/MCP, user-prompt, session, और error callbacks के लिए optional native Copilot SDK SessionHooks compatibility config। यह OpenClaw के portable lifecycle hooks से अलग है।
• permissionPolicy — SDK के onPermissionRequest handler के लिए optional override जो built-in SDK tool kinds (shell, write, read, url, mcp, memory, hook) के लिए उपयोग होता है। Safety net के रूप में default rejectAllPolicy है; व्यवहार में SDK उन kinds में से किसी को भी कभी invoke नहीं करता क्योंकि हर bridged OpenClaw tool overridesBuiltInTool: true और skipPermission: true के साथ registered है, इसलिए 100% tool calls OpenClaw के wrapped execute() से flow करते हैं। देखें Permissions and ask_user।
• enableSessionTelemetry — optional SDK session telemetry flag।

​

Compaction

1. Pending work continue किए बिना tracked SDK session resume करता है।
2. SDK का session-scoped history compaction RPC call करता है।
3. Workspace के अंतर्गत compatibility marker files लिखे बिना SDK compaction outcome return करता है।

​

ट्रांसक्रिप्ट मिररिंग

​

पार्श्व प्रश्न (/btw)

​

Doctor

• एक empty legacyConfigRules (MVP में कोई retired fields नहीं)।
• एक no-op normalizeCompatibilityConfig (ताकि future field retirements के लिए एक stable in-tree home रहे)।
• एक sessionRouteStateOwners entry जो provider github-copilot; runtime copilot; CLI session key copilot; auth profile prefix github-copilot: claim करती है।

​

सीमाएँ

• harness github-copilot और unowned custom BYOK provider ids को claim करता है। Manifest-owned native provider ids अपने owning runtime पर ही रहते हैं, भले ही agentRuntime.id को copilot पर force किया गया हो।
• harness TUI deliver नहीं करता; PI का TUI अप्रभावित है और उन runtimes के लिए fallback बना रहता है जिनके पास peer surface नहीं है।
• जब कोई agent copilot पर switch करता है, तो PI session state migrate नहीं की जाती। चयन per attempt होता है; मौजूदा PI sessions valid रहते हैं।
• ask_user वही OpenClaw prompt-and-reply path उपयोग करता है जो Codex harness करता है। जब Copilot SDK user input मांगता है, OpenClaw active channel/TUI पर blocking prompt post करता है और अगला queued user message SDK request को resolve करता है।

​

अनुमतियाँ और ask_user

• overridesBuiltInTool: true — समान नाम वाले Copilot CLI के built-in tool को replace करता है (edit, read, write, bash, …), ताकि हर tool invocation वापस OpenClaw पर route हो।
• skipPermission: true — SDK को बताता है कि tool invoke करने से पहले onPermissionRequest({kind: "custom-tool"}) fire न करे। wrapped execute() internally अधिक समृद्ध OpenClaw policy check करता है; SDK-level prompt या तो OpenClaw के enforcement को short-circuit करेगा (अगर हम allow-all करें) या हर tool call block करेगा (अगर हम reject-all करें) — इनमें से कोई भी PI parity से मेल नहीं खाता।

​

Session-level GitHub token

​

संबंधित

• Agent runtimes
• Codex harness
• Agent harness plugins (SDK reference)