Files
codex/codex-rs/tools
T
Michael Bolin 6cf832fc63 Extract update_plan tool spec into codex-tools (#16481)
## Why

`codex-rs/core/src/tools/handlers/plan.rs` still owned both the
`update_plan` runtime handler and the static tool definition. The tool
definition is pure metadata, so keeping it in `codex-core` works against
the ongoing effort to move tool-spec code into `codex-tools` and keep
`codex-core` focused on orchestration and execution paths.

This continues the extraction work from #16379, #16471, and #16477.

## What Changed

- added `codex-rs/tools/src/plan_tool.rs` with
`create_update_plan_tool()`
- re-exported that constructor from `codex-rs/tools/src/lib.rs`
- updated `codex-rs/core/src/tools/spec.rs` and
`codex-rs/core/src/tools/spec_tests.rs` to use the `codex-tools` export
instead of a core-local static
- removed the old `PLAN_TOOL` definition from
`codex-rs/core/src/tools/handlers/plan.rs`; the `PlanHandler` runtime
logic still stays in `codex-core`
- tightened two `codex-core` aliases to `#[cfg(test)]` now that
production code no longer needs them

## Testing

- `cargo test -p codex-tools`
- `cargo test -p codex-core tools::spec::tests`

---
[//]: # (BEGIN SAPLING FOOTER)
Stack created with [Sapling](https://sapling-scm.com). Best reviewed
with [ReviewStack](https://reviewstack.dev/openai/codex/pull/16481).
* #16482
* __->__ #16481
6cf832fc63 ยท 2026-04-01 15:51:52 -07:00
History
..

codex-tools

codex-tools is intended to become the home for tool-related code that is shared across multiple crates and does not need to stay coupled to codex-core.

Today this crate is intentionally small. It currently owns the shared tool schema and Responses API tool primitives that no longer need to live in core/src/tools/spec.rs or core/src/client_common.rs:

  • JsonSchema
  • AdditionalProperties
  • ToolDefinition
  • ToolSpec
  • ConfiguredToolSpec
  • ResponsesApiTool
  • FreeformTool
  • FreeformToolFormat
  • ToolSearchOutputTool
  • ResponsesApiWebSearchFilters
  • ResponsesApiWebSearchUserLocation
  • ResponsesApiNamespace
  • ResponsesApiNamespaceTool
  • code-mode ToolSpec adapters and exec / wait spec builders
  • JS REPL spec builders
  • MCP resource, list_dir, and test_sync_tool spec builders
  • local host tool spec builders for shell/exec/request-permissions/view-image
  • collaboration and agent-job ToolSpec builders for spawn/send/wait/close, request_user_input, and CSV fanout/reporting
  • discoverable-tool models, client filtering, and ToolSpec builders for tool_search and tool_suggest
  • parse_tool_input_schema()
  • parse_dynamic_tool()
  • parse_mcp_tool()
  • create_tools_json_for_responses_api()
  • mcp_call_tool_result_output_schema()
  • tool_definition_to_responses_api_tool()
  • dynamic_tool_to_responses_api_tool()
  • mcp_tool_to_responses_api_tool()
  • mcp_tool_to_deferred_responses_api_tool()
  • augment_tool_spec_for_code_mode()
  • tool_spec_to_code_mode_tool_definition()

That extraction is the first step in a longer migration. The goal is not to move all of core/src/tools into this crate in one shot. Instead, the plan is to peel off reusable pieces in reviewable increments while keeping compatibility-sensitive orchestration in codex-core until the surrounding boundaries are ready.

Vision

Over time, this crate should hold tool-facing primitives that are shared by multiple consumers, for example:

  • schema and spec data models
  • tool input/output parsing helpers
  • tool metadata and compatibility shims that do not depend on codex-core
  • other narrowly scoped utility code that multiple crates need

The corresponding non-goals are just as important:

  • do not move codex-core orchestration here prematurely
  • do not pull Session / TurnContext / approval flow / runtime execution logic into this crate unless those dependencies have first been split into stable shared interfaces
  • do not turn this crate into a grab-bag for unrelated helper code

Migration approach

The expected migration shape is:

  1. Move low-coupling tool primitives here.
  2. Switch non-core consumers to depend on codex-tools directly.
  3. Leave compatibility-sensitive adapters in codex-core while downstream call sites are updated.
  4. Only extract higher-level tool infrastructure after the crate boundaries are clear and independently testable.

That means it is normal for codex-core to temporarily re-export types or helpers from codex-tools during the transition.

Crate conventions

This crate should start with stricter structure than core/src/tools so it stays easy to grow:

  • src/lib.rs should remain exports-only.
  • Business logic should live in named module files such as foo.rs.
  • Unit tests for foo.rs should live in a sibling foo_tests.rs.
  • The implementation file should wire tests with:
#[cfg(test)]
#[path = "foo_tests.rs"]
mod tests;

If this crate starts accumulating code that needs runtime state from codex-core, that is a sign to revisit the extraction boundary before adding more here.