Skip to main content

tea_coding_tools/
lib.rs

1#![forbid(unsafe_code)]
2#![deny(missing_docs)]
3
4//! Workspace-scoped native coding tool adapters for the reference Coding CLI.
5//!
6//! Native executors are rooted in an explicit [`WorkspaceRoot`] capability;
7//! they never accept an unconstrained ambient current directory. Path values
8//! from models are bounded, relative, normalized, symlink-contained, and
9//! separated into existing-read and prospective-mutation resolutions.
10
11use std::sync::Arc;
12
13use tea_tools::{ToolExecutor, ToolResourceAccess, ToolResourceResolver, ToolSpec, ToolSpecError};
14
15mod bash;
16mod edit;
17mod edit_diff;
18mod error;
19mod file;
20mod file_error;
21#[cfg(test)]
22mod file_tests;
23mod output;
24mod path;
25mod read;
26mod resource;
27mod search;
28mod web_fetch;
29mod web_search;
30mod workspace;
31mod write;
32
33pub use bash::{BashConfig, BashOutputDirectory, BashShell, BashTool};
34pub use edit::EditTool;
35pub use error::{MAX_WORKSPACE_ERROR_MESSAGE_BYTES, WorkspacePathError, WorkspacePathErrorCode};
36pub use file::{DEFAULT_READ_LINE_LIMIT, MAX_READ_BYTES, MAX_READ_LINE_LIMIT, MAX_WRITE_BYTES};
37pub use file_error::{FileToolError, FileToolErrorCode};
38pub use path::{MAX_WORKSPACE_PATH_BYTES, MAX_WORKSPACE_PATH_COMPONENTS};
39pub use read::ReadTool;
40pub use resource::WorkspaceFileResourceResolver;
41pub use search::{
42    DEFAULT_SEARCH_RESULT_LIMIT, FindTool, GrepTool, LsTool, MAX_SEARCH_DEPTH,
43    MAX_SEARCH_RESULT_LIMIT,
44};
45pub use web_fetch::{
46    DEFAULT_FETCH_CACHE_ENTRIES, DEFAULT_FETCH_CACHE_ENTRY_BYTES, DEFAULT_FETCH_CACHE_TOTAL_BYTES,
47    DEFAULT_FETCH_CACHE_TTL, DEFAULT_FETCH_DECODED_BYTES, DEFAULT_FETCH_HTML_BYTES,
48    DEFAULT_FETCH_HTML_ELEMENTS, DEFAULT_FETCH_MAX_CHARS, DEFAULT_FETCH_RESPONSE_BYTES,
49    DecodedFetchBody, FETCH_SECURITY_POLICY_VERSION, FetchAddressPolicy, FetchAddressPolicyError,
50    FetchBodyDecoder, FetchBodyLimits, FetchCacheConfig, FetchCacheScope, FetchCacheStats,
51    FetchContentKind, FetchDnsResolver, FetchFuture, FetchHttpConfig, FetchHttpHeaders,
52    FetchHttpLimits, FetchHttpResponse, FetchHttpTimeouts, FetchHttpTransport, FetchProvider,
53    FetchProviderError, FetchProviderErrorCode, FetchRedirect, FetchRequest, FetchRequestError,
54    FetchResolveFuture, FetchResult, FetchResultCache, FetchRetryDisposition,
55    FetchTruncationReason, FetchUrlPolicy, FetchUrlPolicyError, FetchUrlScheme, HttpFetchProvider,
56    MAX_FETCH_CACHE_ENTRIES, MAX_FETCH_CACHE_ENTRY_BYTES, MAX_FETCH_CACHE_TOTAL_BYTES,
57    MAX_FETCH_CACHE_TTL, MAX_FETCH_DECODED_BYTES, MAX_FETCH_MAX_CHARS, MAX_FETCH_MIME_BYTES,
58    MAX_FETCH_REDIRECTS, MAX_FETCH_RESPONSE_BYTES, MAX_FETCH_TITLE_BYTES, MAX_FETCH_URL_BYTES,
59    SystemFetchDnsResolver, ValidatedFetchAddresses, ValidatedFetchUrl, WebFetchTool,
60};
61pub use web_search::{
62    DEFAULT_TAVILY_SEARCH_ENDPOINT, DEFAULT_WEB_SEARCH_RESULT_LIMIT, MAX_WEB_SEARCH_QUERY_BYTES,
63    MAX_WEB_SEARCH_RESPONSE_BYTES, MAX_WEB_SEARCH_RESULT_LIMIT, SearchFuture, SearchProvider,
64    SearchProviderError, SearchProviderErrorCode, SearchRequest, SearchRequestError,
65    SearchResponse, SearchResult, TavilyApiKey, TavilySearchConfig, TavilySearchProvider,
66    WebSearchTool,
67};
68pub use workspace::{ResolvedExistingPath, ResolvedMutationPath, WorkspaceRoot};
69pub use write::WriteTool;
70
71/// One native client-tool registration ready for a runtime or session builder.
72pub type NativeToolRegistration = (
73    ToolSpec,
74    Arc<dyn ToolResourceResolver>,
75    Arc<dyn ToolExecutor>,
76);
77
78/// Builds the workspace-confined `read`, `grep`, `find`, and `ls` tool preset.
79///
80/// # Errors
81///
82/// Returns an error when a built-in tool specification cannot be constructed.
83pub fn read_only_workspace_tools(
84    workspace: &WorkspaceRoot,
85) -> Result<Vec<NativeToolRegistration>, ToolSpecError> {
86    let resolver = || {
87        Arc::new(WorkspaceFileResourceResolver::new(ToolResourceAccess::Read))
88            as Arc<dyn ToolResourceResolver>
89    };
90    Ok(vec![
91        (
92            ReadTool::spec()?,
93            resolver(),
94            Arc::new(ReadTool::new(workspace.clone())),
95        ),
96        (
97            GrepTool::spec()?,
98            resolver(),
99            Arc::new(GrepTool::new(workspace.clone())),
100        ),
101        (
102            FindTool::spec()?,
103            resolver(),
104            Arc::new(FindTool::new(workspace.clone())),
105        ),
106        (
107            LsTool::spec()?,
108            resolver(),
109            Arc::new(LsTool::new(workspace.clone())),
110        ),
111    ])
112}
113
114/// Returns the package version embedded at compile time.
115#[must_use]
116pub const fn package_version() -> &'static str {
117    env!("CARGO_PKG_VERSION")
118}