research-agent 0.2.3

//! MCP tool parameter structs.
//!
//! Each derives `serde::Deserialize + schemars::JsonSchema` (required by rmcp so
//! the tool's `inputSchema` is derived automatically). Only **primitive** types
//! are used — research-agent domain types (which derive `Serialize` but **not**
//! `JsonSchema`) are returned from tools as opaque `serde_json::Value` instead.
//!
//! Tools that take no parameters (`init`, `index_rebuild`, `state`,
//! `topics_list`) declare no `Parameters` at all, mirroring BYOH's `genre_list`.

use schemars::JsonSchema;
use serde::Deserialize;

#[derive(Debug, Deserialize, JsonSchema)]
pub struct IngestParams {
    /// Search query (required for arxiv/s2/openalex/europepmc/preprints/all;
    /// ignored for pdf).
    #[serde(default)]
    pub query: Option<String>,
    /// Source: "arxiv" | "s2" | "openalex" | "europepmc" | "preprints" | "all"
    /// | "pdf" (default "all").
    #[serde(default = "default_source")]
    pub source: String,
    /// Maximum papers to fetch for remote sources (default 10).
    #[serde(default = "default_limit")]
    pub limit: usize,
    /// Path to a PDF file or directory (required for source=pdf).
    #[serde(default)]
    pub path: Option<String>,
    /// Optional topic id to link the ingested papers to.
    #[serde(default)]
    pub topic: Option<String>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct ImportPapersParams {
    /// Path to a .bib/.bibtex/.json file, or a directory of them.
    pub path: String,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct PaperBodyParams {
    /// Paper id.
    pub id: String,
    /// When set, return matching snippets with their section and page instead
    /// of the truncated whole body.
    pub query: Option<String>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct PaperReferencesParams {
    /// Paper id.
    pub id: String,
    /// Direction: "references" (default, works the paper cites) or
    /// "cited_by" (works citing the paper).
    pub direction: Option<String>,
    /// Also label edges with Semantic Scholar citation intents
    /// (background/methodology/result, influential). Costs one extra
    /// rate-limited request; defaults to false.
    pub intents: Option<bool>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct QueryPapersParams {
    pub query: String,
    /// Maximum results (default 20).
    #[serde(default = "default_query_limit")]
    pub limit: usize,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct MissingKeywordsParams {
    /// Maximum papers to return (default 20).
    #[serde(default = "default_query_limit")]
    pub limit: usize,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct EnrichPaperParams {
    pub id: String,
    /// Keywords separated by "; ", e.g. "transformer; self-attention".
    pub keywords: String,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct TopicBriefParams {
    /// Topic id to collect.
    pub topic: String,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct GapInput {
    /// What the library is missing, in one sentence.
    pub description: String,
    /// missing_literature | unanswered_question | methodology_gap | connection_gap
    #[serde(default)]
    pub gap_type: Option<String>,
    /// 0.0–1.0 (default 0.5).
    #[serde(default)]
    pub priority: Option<f32>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct GapsRecordParams {
    /// Topic id the gaps belong to.
    pub topic: String,
    /// The gaps to record.
    pub gaps: Vec<GapInput>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct ListGapsParams {
    /// Optional topic id filter.
    #[serde(default)]
    pub topic: Option<String>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct ReportTopicParams {
    /// Comma-separated topic ids.
    pub topics: String,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct ReportSaveParams {
    /// Report title.
    pub title: String,
    /// Comma-separated topic ids the report covers.
    pub topics: String,
    /// Full markdown. Sections split on '## ' headings.
    pub markdown: String,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct TopicAddParams {
    pub name: String,
    #[serde(default)]
    pub description: String,
    /// Parent topic id (creates a sub-topic).
    #[serde(default)]
    pub parent: Option<String>,
}

#[derive(Debug, Deserialize, JsonSchema)]
pub struct UpdateReadParams {
    /// Paper id.
    pub id: String,
    /// New status: unread | queued | in_progress | completed | abandoned.
    #[serde(default)]
    pub status: Option<String>,
    /// Rating 1–5.
    #[serde(default)]
    pub rating: Option<u8>,
}

fn default_source() -> String {
    "all".to_string()
}
fn default_limit() -> usize {
    10
}
fn default_query_limit() -> usize {
    20
}