@iflow-mcp/lupuletic-onyx-mcp-server 1.2.2

package/build/types/index.d.ts

@@ -0,0 +1,157 @@
+/**
+ * Type definitions for the Onyx MCP Server
+ */
+/**
+ * Onyx search result interface
+ */
+export interface OnyxSearchResult {
+    document_id: string;
+    chunk_ind: number;
+    semantic_identifier: string;
+    link?: string;
+    blurb: string;
+    source_type: string;
+    score: number;
+    match_highlights?: string[];
+}
+/**
+ * Onyx document interface
+ */
+export interface OnyxDocument {
+    document_id: string;
+    semantic_identifier: string;
+}
+/**
+ * Document information interface
+ */
+export interface DocumentInfo {
+    num_chunks: number;
+    num_tokens: number;
+}
+/**
+ * Chunk information interface
+ */
+export interface ChunkInfo {
+    content: string;
+    num_tokens: number;
+}
+/**
+ * Configuration for the Onyx server
+ */
+export interface OnyxConfig {
+    apiUrl: string;
+    apiToken: string;
+}
+/**
+ * Search parameters interface
+ */
+export interface SearchParams {
+    query: string;
+    documentSets?: string[];
+    maxResults?: number;
+    chunksAbove?: number;
+    chunksBelow?: number;
+    retrieveFullDocuments?: boolean;
+}
+/**
+ * Chat parameters interface
+ */
+export interface ChatParams {
+    query: string;
+    personaId?: number;
+    documentSets?: string[];
+    enableAutoDetectFilters?: boolean;
+    chatSessionId?: string | null;
+}
+/**
+ * Chat content response interface
+ */
+export interface ChatContentResponse {
+    type: string;
+    text: string;
+    metadata?: {
+        chat_session_id: string;
+    };
+}
+/**
+ * Tool schemas for MCP
+ */
+export declare const toolSchemas: {
+    search_onyx: {
+        name: string;
+        description: string;
+        inputSchema: {
+            type: string;
+            properties: {
+                query: {
+                    type: string;
+                    description: string;
+                };
+                chunksAbove: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                chunksBelow: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                retrieveFullDocuments: {
+                    type: string;
+                    description: string;
+                    default: boolean;
+                };
+                documentSets: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                maxResults: {
+                    type: string;
+                    description: string;
+                    minimum: number;
+                    maximum: number;
+                };
+            };
+            required: string[];
+        };
+    };
+    chat_with_onyx: {
+        name: string;
+        description: string;
+        inputSchema: {
+            type: string;
+            properties: {
+                query: {
+                    type: string;
+                    description: string;
+                };
+                personaId: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                chatSessionId: {
+                    type: string;
+                    description: string;
+                };
+                documentSets: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                enableAutoDetectFilters: {
+                    type: string;
+                    description: string;
+                    default: boolean;
+                };
+            };
+            required: string[];
+        };
+    };
+};

package/build/types/index.js

@@ -0,0 +1,86 @@
+/**
+ * Type definitions for the Onyx MCP Server
+ */
+/**
+ * Tool schemas for MCP
+ */
+export const toolSchemas = {
+    search_onyx: {
+        name: 'search_onyx',
+        description: 'Search the Onyx backend for relevant documents',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: {
+                    type: 'string',
+                    description: 'The topic to search for',
+                },
+                chunksAbove: {
+                    type: 'integer',
+                    description: 'Number of chunks to include above the matching chunk (default: 1)',
+                    default: 1
+                },
+                chunksBelow: {
+                    type: 'integer',
+                    description: 'Number of chunks to include below the matching chunk (default: 1)',
+                    default: 1
+                },
+                retrieveFullDocuments: {
+                    type: 'boolean',
+                    description: 'Whether to retrieve full documents instead of just matching chunks (default: false)',
+                    default: false
+                },
+                documentSets: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'List of document set names to search within (empty for all)',
+                },
+                maxResults: {
+                    type: 'integer',
+                    description: 'Maximum number of results to return (default: 5)',
+                    minimum: 1,
+                    maximum: 10,
+                },
+            },
+            required: ['query'],
+        },
+    },
+    chat_with_onyx: {
+        name: 'chat_with_onyx',
+        description: 'Chat with Onyx to get comprehensive answers',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: {
+                    type: 'string',
+                    description: 'The question to ask Onyx'
+                },
+                personaId: {
+                    type: 'integer',
+                    description: 'The ID of the persona to use (default: 15)',
+                    default: 15
+                },
+                chatSessionId: {
+                    type: 'string',
+                    description: 'Existing chat session ID to continue a conversation (optional)'
+                },
+                documentSets: {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                    description: 'List of document set names to search within (empty for all)'
+                },
+                enableAutoDetectFilters: {
+                    type: 'boolean',
+                    description: 'Whether to enable auto-detection of filters (default: true)',
+                    default: true
+                }
+            },
+            required: ['query']
+        }
+    }
+};
+//# sourceMappingURL=index.js.map

package/build/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAkFH;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE;QACX,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,gDAAgD;QAC7D,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,yBAAyB;iBACvC;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,mEAAmE;oBAChF,OAAO,EAAE,CAAC;iBACX;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,mEAAmE;oBAChF,OAAO,EAAE,CAAC;iBACX;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,qFAAqF;oBAClG,OAAO,EAAE,KAAK;iBACf;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;oBACD,WAAW,EAAE,6DAA6D;iBAC3E;gBACD,UAAU,EAAE;oBACV,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,kDAAkD;oBAC/D,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,EAAE;iBACZ;aACF;YACD,QAAQ,EAAE,CAAC,OAAO,CAAC;SACpB;KACF;IACD,cAAc,EAAE;QACd,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,6CAA6C;QAC1D,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,0BAA0B;iBACxC;gBACD,SAAS,EAAE;oBACT,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,4CAA4C;oBACzD,OAAO,EAAE,EAAE;iBACZ;gBACD,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,gEAAgE;iBAC9E;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;qBACf;oBACD,WAAW,EAAE,6DAA6D;iBAC3E;gBACD,uBAAuB,EAAE;oBACvB,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,6DAA6D;oBAC1E,OAAO,EAAE,IAAI;iBACd;aACF;YACD,QAAQ,EAAE,CAAC,OAAO,CAAC;SACpB;KACF;CACF,CAAC"}

package/package.json

@@ -0,0 +1 @@
+{"name": "@iflow-mcp/lupuletic-onyx-mcp-server", "version": "1.2.2", "description": "Model Context Protocol (MCP) server for seamless integration with Onyx AI knowledge bases", "main": "build/index.js", "type": "module", "bin": {"iflow-mcp-lupuletic-onyx-mcp-server": "build/index.js"}, "scripts": {"build": "tsc && chmod +x build/index.js", "start": "node build/index.js", "dev": "ts-node src/index.ts", "commit": "cz", "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.cjs", "test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.cjs --watch", "test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.cjs --coverage", "lint": "eslint . --ext .ts --config .eslintrc.cjs --max-warnings=${ESLINT_MAX_WARNINGS:-0}", "lint:fix": "eslint . --ext .ts --config .eslintrc.cjs --fix", "prepare": "husky install", "prepublishOnly": "npm run lint && npm run test && npm run build"}, "keywords": ["mcp", "onyx", "search", "ai", "knowledge-base", "rag", "llm", "chat", "semantic-search"], "author": "Onyx MCP Server Contributors", "license": "MIT", "repository": {"type": "git", "url": "https://github.com/lupuletic/onyx-mcp-server.git"}, "homepage": "https://github.com/lupuletic/onyx-mcp-server#readme", "bugs": {"url": "https://github.com/lupuletic/onyx-mcp-server/issues"}, "files": ["build/**/*", "LICENSE", "README.md", "CHANGELOG.md"], "dependencies": {"@modelcontextprotocol/sdk": "latest", "axios": "^1.6.7"}, "devDependencies": {"@types/jest": "^29.5.12", "@types/node": "^20.11.19", "@commitlint/cli": "^18.6.0", "@commitlint/config-conventional": "^18.6.0", "@typescript-eslint/eslint-plugin": "^7.0.1", "@typescript-eslint/parser": "^7.0.1", "commitizen": "^4.3.0", "cz-conventional-changelog": "^3.3.0", "eslint": "^8.56.0", "husky": "^9.1.7", "jest": "^29.7.0", "lint-staged": "^15.5.0", "nock": "^13.5.1", "ts-jest": "^29.1.2", "ts-node": "^10.9.2", "typescript": "^5.3.3"}, "lint-staged": {"*.ts": "eslint --config .eslintrc.cjs --fix"}, "config": {"commitizen": {"path": "cz-conventional-changelog"}}, "commitlint": {"extends": ["@commitlint/config-conventional"]}}