@selfagency/beans-mcp 0.1.2 → 0.1.3

package/src/test/utils.test.ts

@@ -0,0 +1,81 @@
+import { describe, expect, it } from 'vitest';
+import { isPathWithinRoot, makeTextAndStructured } from '../utils';
+
+describe('isPathWithinRoot', () => {
+  it('should return true for paths within root', () => {
+    const root = '/workspace/.beans';
+    const target = '/workspace/.beans/file.md';
+    expect(isPathWithinRoot(root, target)).toBe(true);
+  });
+
+  it('should return false for paths outside root', () => {
+    const root = '/workspace/.beans';
+    const target = '/workspace/outside.md';
+    expect(isPathWithinRoot(root, target)).toBe(false);
+  });
+
+  it('should return false for paths with parent traversal', () => {
+    const root = '/workspace/.beans';
+    const target = '/workspace/.beans/../../etc/passwd';
+    expect(isPathWithinRoot(root, target)).toBe(false);
+  });
+
+  it('should handle relative path normalization', () => {
+    const root = '/workspace/.beans/';
+    const target = '/workspace/.beans/subdir/file.md';
+    expect(isPathWithinRoot(root, target)).toBe(true);
+  });
+
+  it('should return false when root and target are the same', () => {
+    const root = '/workspace/.beans';
+    const target = '/workspace/.beans';
+    expect(isPathWithinRoot(root, target)).toBe(false);
+  });
+
+  it('should handle paths with trailing slashes', () => {
+    const root = '/workspace/.beans/';
+    const target = '/workspace/.beans/file.md';
+    expect(isPathWithinRoot(root, target)).toBe(true);
+  });
+});
+
+describe('makeTextAndStructured', () => {
+  it('should serialize object as JSON text', () => {
+    const input = { name: 'test', value: 42 } as const;
+    const result = makeTextAndStructured(input);
+
+    expect(result.content).toHaveLength(1);
+    expect(result.content[0].type).toBe('text');
+    expect(() => JSON.parse(result.content[0].text)).not.toThrow();
+    expect(JSON.parse(result.content[0].text)).toEqual(input);
+  });
+
+  it('should preserve arbitrary fields', () => {
+    const input = { message: 'Operation completed', extra: { ok: true } } as const;
+    const result = makeTextAndStructured(input as any);
+    expect(JSON.parse(result.content[0].text)).toEqual(input);
+  });
+
+  it('should include nested bean objects in JSON text', () => {
+    const input = { bean: { id: 'b1', title: 'My Bean' } } as const;
+    const result = makeTextAndStructured(input as any);
+    const parsed = JSON.parse(result.content[0].text);
+    expect(parsed).toEqual(input);
+  });
+
+  it('should handle arrays in JSON text', () => {
+    const input = { items: [1, 2, 3] };
+    const result = makeTextAndStructured(input);
+    const parsed = JSON.parse(result.content[0].text);
+    expect(parsed.items).toEqual([1, 2, 3]);
+  });
+
+  it('should handle null and undefined values', () => {
+    const input = { nullValue: null, undefinedValue: undefined } as any;
+    const result = makeTextAndStructured(input);
+    const parsed = JSON.parse(result.content[0].text);
+    expect(parsed.nullValue).toBeNull();
+    // Note: undefined properties are omitted by JSON.stringify
+    expect(Object.prototype.hasOwnProperty.call(parsed, 'undefinedValue')).toBe(false);
+  });
+});

package/src/types.ts

@@ -0,0 +1,46 @@
+/**
+ * Public types for beans-mcp-server
+ */
+
+export type SortMode =
+  | "status-priority-type-title"
+  | "updated"
+  | "created"
+  | "id";
+
+export type BeanRecord = {
+  id: string;
+  slug: string;
+  path: string;
+  title: string;
+  body: string;
+  status: string;
+  type: string;
+  description?: string;
+  priority?: string;
+  tags?: string[];
+  parentId?: string;
+  blockingIds?: string[];
+  blockedByIds?: string[];
+  createdAt?: string;
+  updatedAt?: string;
+  etag?: string;
+};
+
+/**
+ * GraphQL error shape as returned by the Beans CLI GraphQL endpoint.
+ */
+export type GraphQLError = {
+  message: string;
+  locations?: Array<{ line: number; column: number }>;
+  path?: Array<string | number>;
+  extensions?: Record<string, unknown>;
+};
+
+export const DEFAULT_MCP_PORT = 39173;
+
+export const MAX_ID_LENGTH = 128;
+export const MAX_TITLE_LENGTH = 1024;
+export const MAX_METADATA_LENGTH = 128;
+export const MAX_DESCRIPTION_LENGTH = 65536; // 64KB
+export const MAX_PATH_LENGTH = 1024;

package/src/utils.ts

@@ -0,0 +1,20 @@
+import { isAbsolute, relative, resolve } from 'node:path';
+
+/**
+ * Check whether `target` is contained within `root` after resolving both paths.
+ * Guards against the Windows cross-drive bypass where `path.relative(root, target)`
+ * returns an absolute path (e.g. `D:\evil`) that does not start with `..`.
+ */
+export function isPathWithinRoot(root: string, target: string): boolean {
+  const resolvedRoot = resolve(root);
+  const resolvedTarget = resolve(target);
+  const rel = relative(resolvedRoot, resolvedTarget);
+  return !!rel && !rel.startsWith('..') && !isAbsolute(rel);
+}
+
+export function makeTextAndStructured<T extends Record<string, unknown>>(value: T) {
+  // Return JSON in text content only to avoid duplicate rendering in some clients.
+  return {
+    content: [{ type: 'text' as const, text: JSON.stringify(value, null, 2) }],
+  };
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "lib": ["ES2022"],
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.test.ts", "dist", "node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,42 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig([
+  {
+    // ESM library entry point
+    entry: { index: 'src/index.ts' },
+    format: ['esm'],
+    outDir: 'dist',
+    target: 'node18',
+    splitting: false,
+    dts: true,
+    sourcemap: process.env.NODE_ENV !== 'production',
+    clean: true,
+  },
+  {
+    // CJS library entry point
+    entry: { index: 'src/index.ts' },
+    format: ['cjs'],
+    outDir: 'dist',
+    outExtension: () => ({ js: '.cjs' }),
+    target: 'node18',
+    splitting: false,
+    cjsInterop: true,
+    dts: false,
+    sourcemap: process.env.NODE_ENV !== 'production',
+  },
+  {
+    // CLI binary entry point
+    entry: { 'beans-mcp-server': 'src/cli.ts' },
+    format: ['cjs'],
+    outDir: 'dist',
+    outExtension: () => ({ js: '.cjs' }),
+    target: 'node18',
+    splitting: false,
+    cjsInterop: true,
+    dts: false,
+    sourcemap: process.env.NODE_ENV !== 'production',
+    banner: {
+      js: '#!/usr/bin/env node',
+    },
+  },
+]);

package/vitest.config.ts

@@ -0,0 +1,18 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    globals: false,
+    environment: "node",
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "json", "html"],
+      exclude: [
+        "node_modules/",
+        "dist/",
+        "src/**/*.test.ts",
+        "src/server/backend.ts",
+      ],
+    },
+  },
+});