universal-tool-core 0.2.9

DEPRECATED: Use agentic-tools-* crates and agentic-mcp instead. Core runtime library for Universal Tool Framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

// Re-export the error types
pub mod error;

// Re-export schemars types for use in generated code
pub use schemars::JsonSchema;
pub use schemars::{self};

// CLI utilities module (only available with cli feature)
// NOTE: We use #[cfg(feature = "cli")] to ensure CLI utilities are only available
// when the CLI feature is enabled. This keeps the API clean and follows idiomatic
// Rust practices. Testing confirms this approach works correctly with our examples.
#[cfg(feature = "cli")]
pub mod cli;

// REST utilities module (only available with rest feature)
#[cfg(feature = "rest")]
pub mod rest;

// MCP utilities module (only available with mcp feature)
#[cfg(feature = "mcp")]
pub mod mcp;

// Re-export the macros at the crate root for easy access
// IMPORTANT: Users should NOT depend on universal-tool-macros directly!
// These re-exports ensure that features propagate correctly. When you enable
// a feature on universal-tool-core, it automatically enables the corresponding
// feature on universal-tool-macros, ensuring only the requested code is generated.
pub use universal_tool_macros::universal_tool;
pub use universal_tool_macros::universal_tool_router;

/// The `prelude` module provides a single, convenient import for all essential
/// library items. This is just a convenience - users control their own application structure.
pub mod prelude {
    // Re-export the procedural macros from the other crate.
    // This allows the user to have a single `use` statement.
    pub use universal_tool_macros::universal_tool;
    pub use universal_tool_macros::universal_tool_router;

    // Re-export the error types.
    pub use crate::error::ErrorCode;
    pub use crate::error::ToolError;

    // Re-export JsonSchema for generated code
    pub use schemars::JsonSchema;

    // Re-export CLI utilities when the CLI feature is enabled
    #[cfg(feature = "cli")]
    pub use crate::cli::CliFormatter;
    #[cfg(feature = "cli")]
    pub use crate::cli::OutputFormat;
    #[cfg(feature = "cli")]
    pub use crate::cli::ProgressReporter;

    // Re-export REST utilities when the REST feature is enabled
    #[cfg(feature = "rest")]
    pub use crate::rest::{
        IntoResponse,
        Json,
        Path,
        Query,
        Response,
        State,
        StatusCode,
        // Core axum types for handlers
        axum,
        // Tower utilities
        tower,
        tower_http,
    };

    // Re-export OpenAPI utilities when enabled
    #[cfg(feature = "openapi")]
    pub use crate::rest::utoipa;
    #[cfg(feature = "openapi")]
    pub use crate::rest::utoipa_swagger_ui;

    // Re-export MCP utilities when the MCP feature is enabled
    #[cfg(feature = "mcp")]
    pub use crate::mcp::{
        CancellationToken,
        IntoCallToolResult,
        // Re-export commonly used values
        JsonValue,
        // MCP-specific types
        McpError,
        McpErrorData,
        McpProgressReporter,
        NumberOrString,
        ProgressNotification,
        ProgressToken,
        ServerHandler,
        ToolAnnotations,
        ToolMetadata,
        convert_tool_definitions,
        // Error codes
        error_codes,
        extract_parameter_schema,
        // Helper functions
        generate_schema,
        json,
        // Core rmcp types and functions
        rmcp,
        stdio,
    };

    // Re-export the MCP server macro (exported at crate root due to macro_export)
    #[cfg(feature = "mcp")]
    pub use crate::implement_mcp_server;
}