Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

fix(ok): resolve markdown links an agent writes to a doc (PRD-8112) (#4823)

Abraham5db3f415b63b
diff --git a/.changeset/prd-8112-agent-link-hrefs.md b/.changeset/prd-8112-agent-link-hrefs.md
new file mode 100644
index 000000000..a750e47b3
--- /dev/null
+++ b/.changeset/prd-8112-agent-link-hrefs.md
@@ -0,0 +1,5 @@
+---
+"@inkeep/open-knowledge": patch
+---
+
+A markdown link an agent writes to a document in your project now opens that document in the app. Before, it showed as blocked or did nothing when clicked.
diff --git a/knip.config.ts b/knip.config.ts
index 659eef71e..5b8951125 100644
--- a/knip.config.ts
+++ b/knip.config.ts
@@ -143,15 +143,11 @@ export default {
'packages/server': {
entry: ['src/**/*.test.ts', 'src/parse-worker.ts'],
project: 'src/**',
- ignoreDependencies: [
- '@types/shell-quote',
- ],
+ ignoreDependencies: ['@types/shell-quote'],
},
'packages/cli': {
entry: ['src/**/*.test.ts', 'scripts/*.ts', 'tests/**/*.ts', 'src/parse-worker.ts'],
- ignoreDependencies: [
- 'yjs',
- ],
+ ignoreDependencies: ['yjs'],
},
'packages/desktop': {
entry: [
diff --git a/packages/app/src/components/acp/AgentMarkdown.dom.test.tsx b/packages/app/src/components/acp/AgentMarkdown.dom.test.tsx
index d221413a5..230e2e5c8 100644
--- a/packages/app/src/components/acp/AgentMarkdown.dom.test.tsx
+++ b/packages/app/src/components/acp/AgentMarkdown.dom.test.tsx
@@ -104,6 +104,27 @@ describe('AgentMarkdown doc-path links', () => {
setDocPathResolver(null);
});
+ test('a markdown link the agent wrote to a doc opens in-app instead of being blocked', () => {
+ const { container } = renderWithResolver(
+ 'See [REPORT.md](public/open-knowledge/reports/foo/REPORT.md) for the findings.',
+ );
+
+ const anchor = container.querySelector('[data-testid="agent-thread-doc-link"]');
+ expect(anchor?.getAttribute('href')).toBe('#/reports/foo/REPORT');
+ expect(anchor?.textContent).toBe('REPORT.md');
+ expect(container.textContent).not.toContain('[blocked]');
+ });
+
+ test('a markdown link to a file: URL of a workspace doc opens in-app too', () => {
+ const { container } = renderWithResolver(
+ '[the report](file:///Users/abraham/repo/public/open-knowledge/reports/foo/REPORT.md)',
+ );
+
+ const anchor = container.querySelector('[data-testid="agent-thread-doc-link"]');
+ expect(anchor?.getAttribute('href')).toBe('#/reports/foo/REPORT');
+ expect(container.textContent).not.toContain('[blocked]');
+ });
+
test('a repo-root-relative .md path in prose renders as an in-app hash link', () => {
const { container } = renderWithResolver(
'Written to public/open-knowledge/reports/foo/REPORT.md (458 lines)',
diff --git a/packages/app/src/components/acp/doc-path-links.test.ts b/packages/app/src/components/acp/doc-path-links.test.ts
index c6ebe89db..090d6369b 100644
--- a/packages/app/src/components/acp/doc-path-links.test.ts
+++ b/packages/app/src/components/acp/doc-path-links.test.ts
@@ -335,4 +335,44 @@ describe('remarkDocPathLinks', () => {
expect(kids[2]).toEqual({ type: 'text', value: ' into ' });
expect(kids[3]?.url).toBe('#/b/two');
});
+
+ test('a link the agent wrote to a doc path becomes an in-app link, text untouched', () => {
+ for (const href of [
+ 'public/open-knowledge/reports/foo/REPORT.md',
+ '/Users/abraham/repo/public/open-knowledge/reports/foo/REPORT.md',
+ 'file:///Users/abraham/repo/public/open-knowledge/reports/foo/REPORT.md',
+ 'reports/foo/REPORT.md#findings',
+ 'public/open-knowledge/reports/foo/REPORT%2Emd',
+ ]) {
+ const tree = makeTree([
+ {
+ type: 'paragraph',
+ children: [{ type: 'link', url: href, children: [{ type: 'text', value: 'REPORT.md' }] }],
+ },
+ ]);
+ setDocPathResolver(resolve);
+ remarkDocPathLinks()()(tree);
+ const link = tree.children?.[0]?.children?.[0];
+ expect(link?.url, href).toBe('#/reports/foo/REPORT');
+ expect(link?.children?.[0]).toEqual({ type: 'text', value: 'REPORT.md' });
+ }
+ });
+
+ test('a link to a doc that is not in the workspace is left exactly as written', () => {
+ for (const href of [
+ 'public/open-knowledge/reports/nope/REPORT.md',
+ 'mailto:[email protected]',
+ '#/already/in-app',
+ ]) {
+ const tree = makeTree([
+ {
+ type: 'paragraph',
+ children: [{ type: 'link', url: href, children: [{ type: 'text', value: 'x' }] }],
+ },
+ ]);
+ setDocPathResolver(resolve);
+ remarkDocPathLinks()()(tree);
+ expect(tree.children?.[0]?.children?.[0]?.url, href).toBe(href);
+ }
+ });
});
diff --git a/packages/app/src/components/acp/doc-path-links.ts b/packages/app/src/components/acp/doc-path-links.ts
index 05ee9712c..1bc88ca5a 100644
--- a/packages/app/src/components/acp/doc-path-links.ts
+++ b/packages/app/src/components/acp/doc-path-links.ts
@@ -103,7 +103,8 @@ function rewriteNode(node: MdastNode | undefined, resolver: DocPathResolver): vo
for (const child of children) {
if (child === undefined || child === null) continue;
if (child.type === 'link') {
- next.push(child);
+ const doc = typeof child.url === 'string' ? resolveLinkUrl(child.url, resolver) : null;
+ next.push(doc === null ? child : { ...child, url: hashFromDocName(doc) });
continue;
}
if (child.type === 'text' && typeof child.value === 'string') {
@@ -130,6 +131,22 @@ function rewriteNode(node: MdastNode | undefined, resolver: DocPathResolver): vo
node.children = next;
}
+const FILE_SCHEME = /^file:\/\//i;
+const OTHER_SCHEME = /^[a-z][a-z0-9+.-]*:/i;
+
+function resolveLinkUrl(url: string, resolver: DocPathResolver): string | null {
+ if (url.startsWith('#')) return null;
+ const path = FILE_SCHEME.test(url) ? url.replace(FILE_SCHEME, '') : url;
+ if (OTHER_SCHEME.test(path)) return null;
+ let decoded = path;
+ try {
+ decoded = decodeURIComponent(path);
+ } catch {
+ return null;
+ }
+ return resolver(decoded);
+}
+
function splitTextByPaths(value: string, resolver: DocPathResolver): MdastNode[] {
const out: MdastNode[] = [];
let cursor = 0;
diff --git a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
index a28cc2b18..8a60e5826 100644
--- a/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
+++ b/packages/app/tests/integration/bug3-source-mode-writeback.test.ts
@@ -1,4 +1,3 @@
-
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
index 4fc2c11f9..6fcdc23f2 100644
--- a/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
+++ b/packages/app/tests/integration/indented-jsx-byte-sacred.test.ts
@@ -1,4 +1,3 @@
-
import { setTimeout as wait } from 'node:timers/promises';
import { normalizeBridge } from '@inkeep/open-knowledge-core';
import { updateYFragment } from '@tiptap/y-tiptap';
diff --git a/packages/app/tests/integration/interior-edit-freshness.test.ts b/packages/app/tests/integration/interior-edit-freshness.test.ts
index 9f2f6feb6..40b5cdfd6 100644
--- a/packages/app/tests/integration/interior-edit-freshness.test.ts
+++ b/packages/app/tests/integration/interior-edit-freshness.test.ts
@@ -1,4 +1,3 @@
-
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
index 2a085742b..93666af70 100644
--- a/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
+++ b/packages/app/tests/integration/keystroke-cadence-danger-space.test.ts
@@ -1,4 +1,3 @@
-
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/producer-guard-wiring.test.ts b/packages/app/tests/integration/producer-guard-wiring.test.ts
index 878d5196b..867598d34 100644
--- a/packages/app/tests/integration/producer-guard-wiring.test.ts
+++ b/packages/app/tests/integration/producer-guard-wiring.test.ts
@@ -1,4 +1,3 @@
-
import { setTimeout as wait } from 'node:timers/promises';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
diff --git a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
index 4ada3cf26..0970ac12f 100644
--- a/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
+++ b/packages/app/tests/integration/qa-039-reconciliation-counters-http.test.ts
@@ -1,4 +1,3 @@
-
import { randomUUID } from 'node:crypto';
import { afterEach, describe, expect, test } from 'vitest';
import { agentWriteMd, createTestServer, type TestServer } from './test-harness';
diff --git a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
index cbe2b705f..b632185e1 100644
--- a/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
+++ b/packages/app/tests/integration/qa-045-restore-after-gc.test.ts
@@ -1,4 +1,3 @@
-
import { execFileSync } from 'node:child_process';
import { randomUUID } from 'node:crypto';
import { join } from 'node:path';
diff --git a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
index 89bc9b4d9..c530ce4ba 100644
--- a/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
+++ b/packages/app/tests/integration/qa-050-rollback-undo-shipped-path.test.ts
@@ -1,4 +1,3 @@
-
import { randomUUID } from 'node:crypto';
import { afterAll, afterEach, beforeAll, describe, expect, test } from 'vitest';
import type * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-after-rollback.test.ts b/packages/app/tests/integration/undo-after-rollback.test.ts
index a78aeb0e4..d3767adc9 100644
--- a/packages/app/tests/integration/undo-after-rollback.test.ts
+++ b/packages/app/tests/integration/undo-after-rollback.test.ts
@@ -1,4 +1,3 @@
-
import { ROLLBACK_ORIGIN } from '@inkeep/open-knowledge-server';
import { afterAll, beforeAll, describe, expect, test } from 'vitest';
import * as Y from 'yjs';
diff --git a/packages/app/tests/integration/undo-recycle-reset.test.ts b/packages/app/tests/integration/undo-recycle-reset.test.ts
index e7cc69c3f..b076f955c 100644
--- a/packages/app/tests/integration/undo-recycle-reset.test.ts
+++ b/packages/app/tests/integration/undo-recycle-reset.test.ts
@@ -1,4 +1,3 @@
-
import { writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { setTimeout as wait } from 'node:timers/promises';
diff --git a/packages/app/tests/integration/undo-rederive-survival.test.ts b/packages/app/tests/integration/undo-rederive-survival.test.ts
index 9ddcd0730..7935e35f8 100644
--- a/packages/app/tests/integration/undo-rederive-survival.test.ts
+++ b/packages/app/tests/integration/undo-rederive-survival.test.ts
@@ -1,4 +1,3 @@
-
import { prependFrontmatter } from '@inkeep/open-knowledge-core';
import { Plugin, PluginKey } from '@tiptap/pm/state';
import { updateYFragment, yXmlFragmentToProseMirrorRootNode } from '@tiptap/y-tiptap';
diff --git a/packages/core/src/bridge/compose.ts b/packages/core/src/bridge/compose.ts
index 2a597ec3d..f4cc8a286 100644
--- a/packages/core/src/bridge/compose.ts
+++ b/packages/core/src/bridge/compose.ts
@@ -1,4 +1,3 @@
-
import { prependFrontmatter, stripFrontmatter } from '../extensions/frontmatter.ts';
export type ComposeAdjustment = 'none' | 'body' | 'frontmatter' | 'unresolved';
diff --git a/packages/core/src/bridge/doc-boundary-space.ts b/packages/core/src/bridge/doc-boundary-space.ts
index 01ef76a9f..8fb428b90 100644
--- a/packages/core/src/bridge/doc-boundary-space.ts
+++ b/packages/core/src/bridge/doc-boundary-space.ts
@@ -1,4 +1,3 @@
-
import { FRONTMATTER_RE, stripFrontmatter } from '../extensions/frontmatter.ts';
import { carriedEdgeEmpties, type DocEdgeEmpties } from '../markdown/doc-edge-blank-runs.ts';
diff --git a/packages/core/src/markdown/comment-promoter.ts b/packages/core/src/markdown/comment-promoter.ts
index fb0ba5a7c..fc267cbea 100644
--- a/packages/core/src/markdown/comment-promoter.ts
+++ b/packages/core/src/markdown/comment-promoter.ts
@@ -1,4 +1,3 @@
-
import type { Nodes, Paragraph, PhrasingContent, Root, RootContent, Text } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/merged-walker.ts b/packages/core/src/markdown/merged-walker.ts
index fa3cfcd86..bfd7e3109 100644
--- a/packages/core/src/markdown/merged-walker.ts
+++ b/packages/core/src/markdown/merged-walker.ts
@@ -1,4 +1,3 @@
-
import type { Nodes, Parent, Root } from 'mdast';
import { SKIP, visit } from 'unist-util-visit';
import type { VFile } from 'vfile';
diff --git a/packages/core/src/markdown/safe-url.ts b/packages/core/src/markdown/safe-url.ts
index 8be632ba4..4d3250d3a 100644
--- a/packages/core/src/markdown/safe-url.ts
+++ b/packages/core/src/markdown/safe-url.ts
@@ -1,4 +1,3 @@
-
export const SAFE_URL_SCHEMES = ['https', 'http', 'mailto', 'tel', 'ftp', 'sms'] as const;
const SCHEME_ALT = SAFE_URL_SCHEMES.map((s) => `${s}:`).join('|');