Skip to content

Commit 8e7b178

Browse files
authored
Merge pull request #28 from OriginTrail/feat/pdf-to-markdown-tool
feat: add document-to-markdown MCP tool and streamline system prompt
2 parents 1ad8c16 + 77c77a9 commit 8e7b178

21 files changed

Lines changed: 6244 additions & 1546 deletions

.codex/review-prompt.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Read these files before reviewing:
99
1. **`pr-diff.patch`** — The PR diff (generated at runtime). This is the primary input.
1010
2. **`AGENTS.md`** — Project conventions, Definition of Done, plugin patterns, testing requirements, and code quality standards. This is the source of truth for how code in this project should look.
1111

12-
You may read other files in the repository to understand surrounding context (e.g., how a modified function is called, what a referenced constant is). However, all review comments must target lines that appear in the diff.
12+
You may read other files in the repository **only** to understand how code changed in the diff is called or referenced. Do not review, comment on, or mention code in files or packages that are not part of the diff. All review comments and the summary must be strictly scoped to changes introduced by this PR's diff — nothing else.
1313

1414
## Review Philosophy
1515

@@ -26,7 +26,7 @@ When both exist, report blockers first.
2626

2727
Do three passes:
2828

29-
1. **Context + risk-map pass (mandatory)**Read full touched files (not only hunk lines) and identify high-risk zones: platform/runtime boundaries, event handlers, async cleanup (`finally`), auth/validation boundaries, and repeated predicates/guards.
29+
1. **Context + risk-map pass (mandatory)**For each file that appears in the diff, read the full file (not only hunk lines) to understand surrounding context. Do NOT read files or packages that have no changed lines in the diff. Identify high-risk zones in the changed code: platform/runtime boundaries, event handlers, async cleanup (`finally`), auth/validation boundaries, and repeated predicates/guards.
3030
2. **Blockers pass** — Scan for correctness bugs, security issues, API/schema contract breaks, missing migrations, data integrity risks, and missing tests for changed behavior. These are `🔴 Bug` comments.
3131
3. **Maintainability pass** — Scan for code bloat, readability issues, naming problems, pattern violations, hardcoded values, and architecture drift in touched areas. These are `🟡 Issue`, `🔵 Nit`, or `💡 Suggestion` comments.
3232

@@ -53,29 +53,34 @@ If any check fails, skip the comment.
5353
- Logic errors, off-by-one, null/undefined handling, incorrect assumptions, race conditions.
5454
- Boundary conditions — empty arrays, null inputs, zero values, maximum values.
5555
- Error handling — swallowed errors, missing error propagation, unhelpful error messages. Do not flag missing error handling for internal code that cannot reasonably fail.
56+
- Streaming/multipart handlers — verify a request cannot send multiple responses (e.g., multi-file parts triggering repeated `res.json()` calls). If a route expects one file, ensure parser limits and single-response guards exist.
5657
- Unsafe runtime assumptions hidden by type assertions (`as ...`, `as any`, non-null `!`) when values come from events, external I/O, or platform-specific APIs.
5758
- Platform/runtime compatibility assumptions — usage of globals/APIs (`window`, `document`, `Node`, `process`, browser-only APIs) in cross-runtime code paths must be guarded.
5859

5960
#### Security
6061

62+
6163
- Injection risks (SQL, command, XSS) when handling user input.
6264
- Hardcoded secrets — API keys, passwords, tokens in code.
6365
- Missing input validation at system boundaries (user input, external APIs). Not for internal function calls.
6466
- Auth bypass, privilege escalation, or missing authorization checks.
67+
- Filesystem path confinement — when IDs/paths come from requests, verify storage layers enforce root containment via resolved-path checks; do not rely only on caller-side sanitization.
6568

6669
#### API Compatibility
6770

6871
- Breaking changes to API response schemas or status codes without migration path.
6972
- Removed or renamed API endpoints, query parameters, or response fields that existing consumers depend on.
7073
- Database schema changes that require migration or backfill.
7174
- MCP tool signature changes (renamed tools, changed input schemas) that break existing clients.
75+
- HTTP status semantics — ensure client/input errors are 4xx and unexpected internal failures are 5xx; blanket 400 handling in catch-all paths is a correctness/API contract issue.
7276

7377
#### Tests for Changed Behavior
7478

7579
- New behavior must have corresponding tests covering core functionality and error handling.
7680
- Bug fixes must include a regression test that would have caught the original bug.
7781
- Changed behavior must have updated tests reflecting the new expectations.
7882
- If tests are present but brittle (testing implementation details rather than behavior), flag it.
83+
- For single-file upload endpoints, look for regression coverage of multi-file/malformed multipart inputs and confirm no double-response behavior.
7984
- Prefer tests that validate production behavior directly. If a test re-implements production decision logic locally, and could stay green while runtime behavior regresses, flag it and suggest importing shared runtime logic or testing via a higher-level behavior path.
8085

8186
Missing tests for changed behavior are blockers (`🔴 Bug`) only when the change affects user-facing behavior, API contracts, or data integrity. Missing tests for internal refactors or trivial changes are `🟡 Issue`.
@@ -113,6 +118,7 @@ Missing tests for changed behavior are blockers (`🔴 Bug`) only when the chang
113118
- **Wrong import paths in tests** — Tests importing from `src/` instead of `dist/`.
114119
- **Missing test categories** — Tests without "Core Functionality" and "Error Handling" describe blocks.
115120
- **Mixing concerns** — Route handlers doing business logic, database queries in API handlers, etc.
121+
- **Cross-provider behavior drift** — When multiple providers/implementations exist, verify shared options and output semantics behave consistently unless explicitly documented otherwise.
116122

117123
#### Hardcoded Values and Magic Constants
118124

@@ -135,6 +141,7 @@ Do not flag one-off numeric literals that are self-explanatory in context (e.g.,
135141
- Type annotations for code that already type-checks.
136142
- Things that are clearly intentional design choices backed by existing patterns.
137143
- Pre-existing issues in unchanged code outside the diff.
144+
- Code in files or packages that have no changed lines in the diff — even if you read them for context.
138145
- Adding documentation unless a public API is clearly undocumented.
139146

140147
## Comment Format
@@ -174,4 +181,4 @@ The `line` field must refer to the line number in the new version of the file (r
174181

175182
## Summary
176183

177-
Write a brief (2–4 sentence) overall assessment in the `summary` field. Lead with blockers if any exist. Mention whether the PR is clean/minimal or has code quality issues. Include one sentence on maintainability direction in touched areas (improved / neutral / worsened, and why). If the PR looks good, say so.
184+
Write a brief (2–4 sentence) overall assessment in the `summary` field covering **only** what this PR's diff changes. Do not mention code, packages, or behavior outside the diff. Lead with blockers if any exist. Mention whether the PR is clean/minimal or has code quality issues. Include one sentence on maintainability direction in touched areas (improved / neutral / worsened, and why). If the PR looks good, say so.

apps/agent/src/server/scripts/setup.ts

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import {
99
import {
1010
getLLMProviderApiKeyEnvName,
1111
LLMProvider,
12-
DEFAULT_SYSTEM_PROMPT,
1312
} from "@/shared/chat";
13+
import { DEFAULT_SYSTEM_PROMPT } from "@/shared/prompts/defaultSystemPrompt";
1414

1515
async function setup() {
1616
const r = await prompts([
@@ -50,6 +50,25 @@ async function setup() {
5050
initial: DEFAULT_SYSTEM_PROMPT,
5151
format: (val) => (val === DEFAULT_SYSTEM_PROMPT ? "" : val.trim()),
5252
},
53+
{
54+
type: "select",
55+
name: "docConversionProvider",
56+
message: "Document conversion provider",
57+
choices: [
58+
{ title: "unpdf — basic PDF only", value: "unpdf" },
59+
{ title: "Mistral OCR — complex PDF/DOCX/PPTX", value: "mistral" },
60+
],
61+
initial: 0,
62+
},
63+
{
64+
type: (_, a) =>
65+
a.docConversionProvider === "mistral" && a.llmProvider !== "mistralai"
66+
? "text"
67+
: null,
68+
name: "mistralApiKey",
69+
message: "MISTRAL_API_KEY",
70+
validate: (val) => val.length || "Required for Mistral OCR provider",
71+
},
5372
{
5473
type: "select",
5574
name: "dkgEnv",
@@ -132,8 +151,9 @@ async function setup() {
132151
{
133152
type: "text",
134153
name: "dbFilename",
135-
message: "Database filename (i.e: example.db)",
154+
message: "Database filename (e.g. example.db)",
136155
validate: (val) => val.length || "Required",
156+
format: (val) => (val.endsWith(".db") ? val : `${val}.db`),
137157
},
138158
]);
139159

@@ -158,7 +178,8 @@ SMTP_USER="${r.smtpUsername || ""}"
158178
SMTP_PASS="${r.smtpPassword || ""}"
159179
SMTP_SECURE=${r.smtpSecure === undefined ? "true" : r.smtpSecure}
160180
SMTP_FROM="${r.smtpFrom || ""}"
161-
`,
181+
DOCUMENT_CONVERSION_PROVIDER="${r.docConversionProvider}"
182+
${r.docConversionProvider === "mistral" && r.llmProvider !== "mistralai" ? `MISTRAL_API_KEY="${r.mistralApiKey}"\n` : ""}`,
162183
);
163184

164185
console.log("Creating .env.development.local file...");

apps/agent/src/shared/chat.ts

Lines changed: 7 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import type {
99
import type { ToolCallChunk } from "@langchain/core/messages/tool";
1010
import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
1111

12+
import { DEFAULT_SYSTEM_PROMPT } from "./prompts/defaultSystemPrompt";
13+
1214
export type { ToolDefinition };
1315
export type ToolInfo = {
1416
name: string;
@@ -339,7 +341,7 @@ export const processStreamingCompletion = async (
339341
try {
340342
args = tc.args ? JSON.parse(tc.args) : {};
341343
} catch {
342-
// Malformed JSON from partial streaming send raw
344+
// Malformed JSON from partial streaming - send raw
343345
args = {};
344346
}
345347
toolCalls.push({
@@ -358,17 +360,17 @@ export const processStreamingCompletion = async (
358360
writeSSE(res, { event: "done", data: {} });
359361
} catch (streamError) {
360362
if (hasSentContent) {
361-
// Partial content was already sent don't re-invoke and risk
363+
// Partial content was already sent - don't re-invoke and risk
362364
// duplicated/mixed output. Send an error so the UI can recover.
363365
writeSSE(res, {
364366
event: "error",
365367
data: {
366368
message:
367-
"Stream interrupted please retry your message",
369+
"Stream interrupted - please retry your message",
368370
},
369371
});
370372
} else {
371-
// No content sent yet safe to fallback to a full invoke
373+
// No content sent yet - safe to fallback to a full invoke
372374
try {
373375
const result = await provider.invoke(messages, options);
374376
const content = result.content;
@@ -514,42 +516,9 @@ export const makeStreamingCompletionRequest = async (
514516

515517
// Stream ended without an explicit done/error event (server crash, network drop)
516518
if (!streamFinalized) {
517-
callbacks.onError("Connection lost the server stopped responding");
519+
callbacks.onError("Connection lost - the server stopped responding");
518520
}
519521
} finally {
520522
reader.releaseLock();
521523
}
522524
};
523-
524-
export const DEFAULT_SYSTEM_PROMPT = `
525-
You are a DKG Agent that helps users interact with the OriginTrail Decentralized Knowledge Graph (DKG) using available Model Context Protocol (MCP) tools.
526-
Your role is to help users create, retrieve, and analyze verifiable knowledge in a friendly, approachable, and knowledgeable way, making the technology accessible to both experts and non-experts. When replying, use markdown (e.g. bold text, bullet points, tables, etc.) and codeblocks where appropriate to convery messages in a more organized and structured manner.
527-
528-
## Core Responsibilities
529-
- Answer Questions: Retrieve and explain knowledge from the DKG to help users understand and solve problems.
530-
- Create Knowledge Assets: Assist users in publishing new knowledge assets to the DKG using MCP tools.
531-
- Perform Analyses: Use DKG data and MCP tools to perform structured analyses, presenting results clearly.
532-
- Be Helpful and Approachable: Communicate in simple, user-friendly terms. Use analogies and clear explanations where needed, but avoid unnecessary technical jargon unless requested.
533-
534-
## Privacy Rule (IMPORTANT)
535-
When creating or publishing knowledge assets:
536-
- If privacy is explicitly specified, follow the user’s instruction.
537-
- If privacy is NOT specified, ALWAYS set privacy to "private".
538-
- NEVER default to "public" without explicit user consent.
539-
This ensures sensitive information is not unintentionally exposed.
540-
541-
## Interaction Guidelines
542-
1. Clarify intent: When a request is vague, ask polite clarifying questions.
543-
2. Transparency: If information cannot be verified, clearly state limitations and suggest alternatives.
544-
3. Explain outcomes: When retrieving or publishing data, explain what happened in simple terms.
545-
4. Accessibility: Use examples, step-by-step reasoning, or simple metaphors to make complex concepts understandable.
546-
5. Trustworthy behavior: Always emphasize verifiability and reliability of knowledge retrieved or created.
547-
548-
## Examples of Behavior
549-
- User asks to publish knowledge without specifying privacy → Agent publishes with "privacy": "private" and explains:
550-
"I’ve published this knowledge privately so only you (or authorized parties) can access it. If you’d like it public, just let me know."
551-
552-
- User asks to retrieve knowledge → Agent uses MCP retrieval tools and explains results in a simple, structured way.
553-
554-
- User asks a complex analytical question → Agent retrieves relevant knowledge from the DKG, performs the analysis, and presents results in a clear format (e.g., list, table, etc.).
555-
`.trim();

0 commit comments

Comments
 (0)