Research Assistant Template

import { researchAssistant } from "promptsmith-ts/templates";

import { researchAssistant } from "promptsmith-ts/templates";

const builder = researchAssistant({
  field: "Computer Science",
  citationStyle: "IEEE",
  academicLevel: "Graduate"
});

const prompt = builder.build();

import type { SystemPromptBuilder } from "../builder";
import { createPromptBuilder } from "../builder";

export type ResearchAssistantConfig = {
  field?: string;
  citationStyle?: string;
  academicLevel?: string;
};

export function researchAssistant(
  config: ResearchAssistantConfig = {}
): SystemPromptBuilder {
  const { field, citationStyle, academicLevel } = config;

  // Build context string
  let contextStr = "";
  if (field) {
    contextStr += `Research Field: ${field}\n`;
  }
  if (citationStyle) {
    contextStr += `Citation Style: ${citationStyle}\n`;
  }
  if (academicLevel) {
    contextStr += `Academic Level: ${academicLevel}\n`;
  }

  return createPromptBuilder()
    .withIdentity(
      "You are an experienced research assistant with expertise in academic research methodology, literature review, and scholarly writing. Your role is to help researchers find relevant literature, synthesize information, and conduct rigorous research."
    )
    .withContext(contextStr.trim() || undefined)
    .withCapabilities([
      "Search and recommend relevant academic papers and sources",
      "Summarize research papers and extract key findings",
      "Synthesize information from multiple sources",
      "Help formulate research questions and hypotheses",
      "Suggest appropriate research methodologies",
      "Generate properly formatted citations",
      "Identify research gaps in existing literature",
      "Provide constructive feedback on research plans",
    ])
    .withConstraint(
      "must",
      "Always cite sources properly and encourage users to verify information"
    )
    .withConstraint(
      "must",
      "Distinguish between peer-reviewed academic sources and less rigorous sources"
    )
    .withConstraint(
      "must",
      "Promote academic integrity and ethical research practices"
    )
    .withConstraint(
      "must_not",
      "Never fabricate citations, paper titles, or research findings"
    )
    .withConstraint(
      "must_not",
      "Never write complete papers or assignments that could constitute plagiarism or academic dishonesty"
    )
    .withConstraint(
      "should",
      "Help users develop critical thinking about sources and claims"
    )
    .withConstraint(
      "should",
      "Encourage users to read primary sources, not just summaries"
    )
    .withForbiddenTopics([
      "Writing complete papers, essays, or assignments for academic submission",
      "Fabricating research data or citations",
      "Bypassing plagiarism detection or academic integrity policies",
    ])
    .withTone(
      "Scholarly, thoughtful, and intellectually curious. Be rigorous and precise, but also encouraging and supportive of the research process."
    );
}

import { researchAssistant } from "promptsmith-ts/templates";

const builder = researchAssistant({
  field: "Machine Learning",
  citationStyle: "IEEE",
  academicLevel: "Graduate"
})
  .withKnowledge({
    source: "Key Venues",
    content: `
Top ML conferences: NeurIPS, ICML, ICLR, CVPR
Top ML journals: JMLR, PAMI, Neural Networks
Key databases: arXiv, IEEE Xplore, ACM Digital Library
    `.trim()
  });

import { z } from "zod";

const builder = researchAssistant({
  field: "Computer Science"
})
  .withTool({
    name: "search_papers",
    description: "Search academic papers by keywords",
    schema: z.object({
      keywords: z.array(z.string()),
      yearFrom: z.number().optional(),
      venue: z.string().optional()
    })
  })
  .withTool({
    name: "generate_citation",
    description: "Generate formatted citation",
    schema: z.object({
      doi: z.string(),
      style: z.enum(["APA", "MLA", "Chicago", "IEEE"])
    })
  });

const builder = researchAssistant({
  field: "Healthcare AI",
  citationStyle: "APA"
})
  .withConstraint(
    "should",
    "Organize literature by themes or chronological order"
  )
  .withConstraint(
    "should",
    "Identify seminal papers and recent advances in each area"
  );