meerkat-contracts 0.5.2

Wire format contracts and capability registry for Meerkat
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

//! Wire types for model catalog responses.

use crate::version::ContractVersion;
use serde::{Deserialize, Serialize};

/// Model recommendation tier.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "snake_case")]
pub enum WireModelTier {
    /// Tested and recommended for production use.
    Recommended,
    /// Supported but not the primary recommendation.
    Supported,
}

/// Runtime profile for a model — capabilities and parameter schema.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct WireModelProfile {
    /// Model family identifier (e.g., `"claude-opus-4"`, `"gpt-5"`).
    pub model_family: String,
    /// Whether the model accepts a `temperature` parameter.
    pub supports_temperature: bool,
    /// Whether the model supports extended thinking.
    pub supports_thinking: bool,
    /// Whether the model supports explicit reasoning effort control.
    pub supports_reasoning: bool,
    /// Whether the model supports provider-native web search tools.
    #[serde(default)]
    pub supports_web_search: bool,
    /// Whether the model accepts inline video content in user messages.
    pub inline_video: bool,
    /// JSON Schema describing accepted provider-specific parameters.
    pub params_schema: serde_json::Value,
}

/// A single model entry in the catalog response.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct CatalogModelEntry {
    /// Model identifier (e.g., `"claude-sonnet-4-6"`).
    pub id: String,
    /// Human-readable display name.
    pub display_name: String,
    /// Recommendation tier.
    pub tier: WireModelTier,
    /// Maximum input context window in tokens.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub context_window: Option<u32>,
    /// Maximum output tokens per response.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_output_tokens: Option<u32>,
    /// Backing self-hosted server ID for configured aliases.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub server_id: Option<String>,
    /// Model profile with capability flags and parameter schema.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub profile: Option<WireModelProfile>,
}

/// Provider-level grouping in the catalog response.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ProviderCatalog {
    /// Canonical provider name.
    pub provider: String,
    /// Default model ID for this provider.
    pub default_model_id: String,
    /// All catalog models for this provider.
    pub models: Vec<CatalogModelEntry>,
}

/// Response for `models/catalog` — the compiled-in model catalog.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ModelsCatalogResponse {
    /// Contract version.
    pub contract_version: ContractVersion,
    /// Provider-grouped catalog data.
    pub providers: Vec<ProviderCatalog>,
}