copilot-sdk-supercharged 2.5.1 → 2.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +80 -0
  3. data/lib/copilot/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8a7fd46a011b45876248c40e46f1b283271631d2c52e99ebd6a782797dc534cc
4
- data.tar.gz: b05f12f98a4a459b5d8dd3de5fd0606c3d6fd3f0311ec51b2061430832dbd0e1
3
+ metadata.gz: cec80ffc10ca68337bad45a06d83ca887f5c933fb7d5c0188abe4ea059ff4a84
4
+ data.tar.gz: 32bbe2baaed56cec8db0aebc1fe847d2df2cf3a41db3f2ab4b81e61ec98ea602
5
5
  SHA512:
6
- metadata.gz: 60622159ecd94b6140cf217816bab128558e1f9f2e5be7f814fdba56e8aa8158a992b67e1ff24e5499ad99cf657e729db6b5ee7867257f104596b31fc872f53c
7
- data.tar.gz: 58606a5efea0407d47eb7e8453ce2c1c572ffe2e513be46c3cfe339c70822dad16666f7cb11438c99d76b2c97bbb86d845bb0077c508bd9b0955d05a4563c81a
6
+ metadata.gz: 52ae20795b484d1809c41e24e9483dbde5a9182fddd0be53471f9af560e063f9cb08701111729d2e92e5db3610da221a956c2f36febca77ab146c01ad8ebaa76
7
+ data.tar.gz: 333105bc409e00b061de952465137f569f679da1b398764f7edd103b97983f4a5c45dbb3d942812125271d57fbc15a29699f61484588c6edcbfb8d60cbde98b3
data/README.md CHANGED
@@ -291,6 +291,86 @@ session.on(Copilot::SessionEventType::ASSISTANT_MESSAGE_DELTA) do |event|
291
291
  end
292
292
  ```
293
293
 
294
+ ## Recent Features (v2.4–v2.5)
295
+
296
+ Recent upstream syncs added a range of session-configuration options. Except where noted, each is a keyword passed to `client.create_session(...)`.
297
+
298
+ ### New in v2.5
299
+
300
+ - **Reasoning effort** — `reasoning_effort:` — set the model's reasoning budget (e.g. `"low"`, `"medium"`, `"high"`).
301
+ - **Tool search** — `tool_search:` — let the agent discover tools on demand instead of pre-loading them.
302
+ - **Content exclusion** — `content_exclusion:` — honor content-exclusion rules that hide files from the agent.
303
+ - **Session rewind** — `rewind_enabled:` — allow rolling a session back to an earlier snapshot; observe `Copilot::SessionEventType::SESSION_SNAPSHOT_REWIND` events.
304
+ - **Additional directories** — `additional_directories:` — extra workspace directories the agent may access.
305
+ - **Disabled MCP servers** — `disabled_mcp_servers:` — turn off specific MCP servers for the session.
306
+ - **GitHub MCP tool config** — `github_mcp_tool_config:` — configure the built-in GitHub MCP toolset.
307
+ - **Canvas provider** — `canvas_provider:` — supply a canvas rendering provider.
308
+ - **Custom agents local-only** — `custom_agents_local_only:` — restrict custom agents to local definitions.
309
+ - **Built-in plugin directories** — `builtin_plugin_directories:` — directories scanned for built-in plugins.
310
+ - **Agent-factory authoring** — `args_schema:` — author agent factories with a typed args schema.
311
+ - **Permission decision context** — `decision_context:` — extra context passed to permission decisions.
312
+ - **In-process transport** — `in_process:` — run the CLI in-process instead of as a subprocess.
313
+ - **Experimental mode** — `experimental_mode:` — opt into experimental CLI behavior.
314
+ - **MCP OAuth handler** — `on_mcp_auth_request:` — handle OAuth token requests from MCP servers.
315
+
316
+ ### New in v2.4
317
+
318
+ - **Session citations** — `enable_citations:` — emit citation metadata.
319
+ - **Excluded built-in agents** — `excluded_builtin_agents:` — hide specific built-in agents.
320
+ - **Spending limits** — `session_limits:` — cap AI-credit spend with `Copilot::SessionLimitsConfig.new(max_ai_credits:)`.
321
+ - **Session memory** — `memory:` — configure persistent memory with `Copilot::MemoryConfiguration.new(enabled:)`.
322
+ - **OTLP protocol** — `otlp_protocol:` — choose the OTLP telemetry wire protocol.
323
+ - **WebSocket responses** — `enable_web_socket_responses:` — stream responses over WebSocket.
324
+ - **Experiment assignments** — `exp_assignments:` — pass experiment assignments to the runtime.
325
+ - **Tool defer loading** — `Copilot::ToolDefer` (`AUTO` / `NEVER`) — defer tool loading until first use.
326
+ - **System-message sections** — `Copilot::SystemMessageSection` (`PREAMBLE` / `PRESERVE`).
327
+ - **GitHub attachments** — `Copilot::GitHubAttachment` (`GITHUB_COMMIT`, `GITHUB_REPOSITORY`, …).
328
+ - **Post-tool-use / prompt-transformed hooks** — `on_post_tool_use`, `on_user_prompt_transformed` on `Copilot::SessionHooks`.
329
+ - **Per-message agent mode / display prompt** — `agent_mode:` and `display_prompt:` on `session.send` / `session.send_and_wait`.
330
+
331
+ ### Examples
332
+
333
+ ```ruby
334
+ # Reasoning effort + on-demand tool search + content exclusion
335
+ session = client.create_session(
336
+ reasoning_effort: "high",
337
+ tool_search: true,
338
+ content_exclusion: true
339
+ )
340
+ ```
341
+
342
+ ```ruby
343
+ # Enable session rewind and observe rewind snapshots
344
+ session = client.create_session(rewind_enabled: true)
345
+ session.on(Copilot::SessionEventType::SESSION_SNAPSHOT_REWIND) do |event|
346
+ puts "Rewound to snapshot: #{event.data}"
347
+ end
348
+ ```
349
+
350
+ ```ruby
351
+ # Grant the agent access to extra workspace directories
352
+ session = client.create_session(
353
+ additional_directories: ["../shared-lib", "../docs"]
354
+ )
355
+ ```
356
+
357
+ ```ruby
358
+ # Cap AI-credit spend and enable persistent memory
359
+ session = client.create_session(
360
+ session_limits: Copilot::SessionLimitsConfig.new(max_ai_credits: 500),
361
+ memory: Copilot::MemoryConfiguration.new(enabled: true)
362
+ )
363
+ ```
364
+
365
+ ```ruby
366
+ # Per-message agent mode and a display-only prompt
367
+ session.send_and_wait(
368
+ prompt: "Summarize the diff",
369
+ agent_mode: "plan",
370
+ display_prompt: "Summarize the staged changes"
371
+ )
372
+ ```
373
+
294
374
  ## API Reference
295
375
 
296
376
  ### `Copilot::CopilotClient`
@@ -3,5 +3,5 @@
3
3
  # Copyright (c) Microsoft Corporation. All rights reserved.
4
4
 
5
5
  module Copilot
6
- VERSION = "2.5.1"
6
+ VERSION = "2.5.3"
7
7
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: copilot-sdk-supercharged
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.5.1
4
+ version: 2.5.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jeremiah Isaacson
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-08-21 00:00:00.000000000 Z
11
+ date: 2026-08-22 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: |
14
14
  A Ruby SDK for interacting with the GitHub Copilot CLI server via JSON-RPC 2.0.