@compilr-dev/sdk 0.5.1 → 0.5.3

package/dist/platform/sqlite/document-repository.js

@@ -117,6 +117,7 @@ export class SQLiteDocumentRepository {
             notes: 0,
             plan: 0,
             'app-model': 0,
+            'research-model': 0,
         };
         for (const row of results) {
             counts[row.doc_type] = row.count;

package/dist/platform/tools/document-tools.js

@@ -15,6 +15,7 @@ const DOC_TYPE_ENUM = [
     'notes',
     'plan',
     'app-model',
+    'research-model',
 ];
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function createDocumentTools(config) {

package/dist/platform/types.d.ts

@@ -19,7 +19,7 @@ export type WorkItemType = 'feature' | 'bug' | 'tech-debt' | 'chore';
 export type WorkItemStatus = 'backlog' | 'in_progress' | 'completed' | 'skipped';
 export type WorkItemPriority = 'critical' | 'high' | 'medium' | 'low';
 export type GuidedStep = 'plan' | 'implement' | 'test' | 'commit' | 'review';
-export type DocumentType = 'prd' | 'architecture' | 'design' | 'notes' | 'plan' | 'app-model';
+export type DocumentType = 'prd' | 'architecture' | 'design' | 'notes' | 'plan' | 'app-model' | 'research-model';
 export type PlanStatus = 'draft' | 'approved' | 'in_progress' | 'completed' | 'abandoned';
 export interface Project {
     id: number;

package/dist/project-types/configs.js

@@ -142,6 +142,7 @@ export const researchConfig = {
         { role: 'editor', label: 'Editor', description: 'Style, clarity, grammar, consistency' },
     ],
     documentTemplates: [
+        { type: 'research-model', label: 'Research Model', description: 'Paper structure, claims, and sources' },
         { type: 'outline', label: 'Outline', description: 'Paper structure and sections' },
         {
             type: 'literature-review',
@@ -162,6 +163,70 @@ export const researchConfig = {
         chore: { short: 'TK', full: 'Task' },
     },
     systemPromptContext: 'This is an academic research project. The user is writing a research paper or thesis. Focus on academic rigor, proper citations, and structured argumentation.',
+    systemPromptSection: `## Project Context: Research Paper
+
+You are assisting with an academic research project. Your role is to help the user develop a well-structured, properly cited research paper.
+
+### Research Workflow
+The typical research workflow progresses through these phases:
+1. **Topic Definition** — Define research questions and scope
+2. **Literature Review** — Find, analyze, and synthesize sources
+3. **Outline** — Build the paper's argument structure
+4. **Drafting** — Write sections guided by the outline and sources
+5. **Review** — Validate argument, check consistency, identify gaps
+6. **Revision** — Refine based on review feedback
+
+The user may be at any stage. Assess where they are before suggesting next steps.
+
+### Research Model
+This project uses a **Research Model** — a structured representation of the paper stored as a document (doc_type: "research-model"). It tracks:
+- **Sections** — the paper's hierarchical structure, each with a purpose and status
+- **Claims** — assertions made within sections, with evidence strength ratings
+- **Sources** — reference material from the Knowledge Base, linked to claims
+- **Research Questions** — the driving questions the paper addresses
+
+Use the research model tools to read and update this model:
+- \`research_model_get\` — read the model (use scope: "overview" for a quick summary)
+- \`research_model_update\` — add/modify sections, claims, sources, questions
+- \`research_model_validate\` — check for structural errors and research-quality warnings
+
+Always consult the model before making structural suggestions. Update it when the user makes decisions about paper structure.
+
+### Working with Sources
+Reference material is stored in the project's Knowledge Base. When the user uploads or imports a source:
+- Extract key findings relevant to their research questions
+- Identify which claims the source supports or contradicts
+- Link the source to the appropriate claims via \`research_model_update\` (claim_link_source)
+- Mark the source as analyzed when done
+
+### Writing Conventions
+- Every claim that isn't the author's original analysis should be traceable to a source
+- Use formal academic tone unless the user indicates otherwise
+- Maintain consistent terminology across sections
+- Distinguish between the user's original analysis and source-derived information
+- Follow the project's citation style (check the model's citationStyle field)
+
+### Work Items
+Work items in this project represent:
+- **Section** (type: feature) — a section to draft or revise
+- **Revision** (type: bug) — an issue to fix in the argument or content
+- **Reference** (type: tech-debt) — a source to find or analyze
+- **Task** (type: chore) — general administrative work
+
+### Team Agents
+Specialized agents may be available on the team:
+- **Researcher** — deep analysis of sources, literature synthesis, evidence evaluation
+- **Reviewer** — argument validation, gap detection, consistency checking
+- **Editor** — style, clarity, grammar, voice consistency
+
+Suggest delegation when a task would benefit from focused expertise. For example, delegate source analysis to the Researcher, or argument review to the Reviewer.
+
+### Available Skills
+- \`/outline\` — build or refine the paper's section structure
+- \`/literature-review\` — analyze sources and link to claims (when available)
+- \`/draft-section\` — write a section using outline + claims + sources (when available)
+- \`/peer-review\` — validate argument structure and consistency (when available)
+- \`/session-notes\` — summarize work done in this session`,
 };
 // =============================================================================
 // Business Plan / Startup

package/dist/project-types/types.d.ts

@@ -68,6 +68,8 @@ export interface ProjectTypeConfig {
         short: string;
         full: string;
     }>>;
-    /** Context line injected into the system prompt */
+    /** Context line injected into the system prompt (one-liner, deprecated — use systemPromptSection) */
     systemPromptContext: string;
+    /** Rich multi-line system prompt section for the default agent. Takes precedence over systemPromptContext. */
+    systemPromptSection?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compilr-dev/sdk",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Universal agent runtime for building AI-powered applications",
   "type": "module",
   "main": "dist/index.js",