@hypequery/mcp 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are advised to review the applicable
+      documentation for the specific language governing permissions and
+      limitations under each license.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 hypequery
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License. 

package/README.md

@@ -0,0 +1,283 @@
+# @hypequery/mcp
+
+Model Context Protocol (MCP) server for Hypequery semantic layer. Exposes datasets and metrics to AI agents like Claude Desktop, Cursor, and other MCP-compatible tools.
+
+## Features
+
+- **MCP Tools**: List datasets, introspect schemas, query metrics and datasets
+- **Natural Language**: AI-friendly prompts and responses
+- **Type-Safe**: Full TypeScript support with the Hypequery semantic layer
+- **ClickHouse Native**: Optimized for ClickHouse analytics workloads
+
+## Installation
+
+```bash
+npm install @hypequery/mcp
+# or
+pnpm add @hypequery/mcp
+```
+
+## Quick Start
+
+### 1. Create an MCP Config File
+
+Create `mcp-config.ts`:
+
+```typescript
+import { MetricExecutor } from '@hypequery/datasets';
+import { createQueryBuilder } from '@hypequery/clickhouse';
+import { OrdersDataset, CustomersDataset } from './datasets/index.js';
+
+const revenue = OrdersDataset.metric('revenue', { measure: 'revenue' });
+const customerCount = CustomersDataset.metric('customerCount', {
+  measure: 'customerCount',
+});
+
+// Export your datasets
+export const datasets = {
+  orders: {
+    ...OrdersDataset,
+    metrics: { revenue },
+  },
+  customers: {
+    ...CustomersDataset,
+    metrics: { customerCount },
+  },
+};
+
+// Export your executor
+const builderFactory = createQueryBuilder({
+  host: process.env.CLICKHOUSE_HOST,
+  username: process.env.CLICKHOUSE_USER,
+  password: process.env.CLICKHOUSE_PASSWORD,
+});
+
+export const executor = new MetricExecutor({ builderFactory });
+```
+
+### 2. Run the MCP Server
+
+```bash
+npx hypequery-mcp --config ./mcp-config.js
+```
+
+### 3. Configure Claude Desktop
+
+Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
+
+```json
+{
+  "mcpServers": {
+    "hypequery": {
+      "command": "npx",
+      "args": ["hypequery-mcp", "--config", "/absolute/path/to/mcp-config.js"]
+    }
+  }
+}
+```
+
+### 4. Use with Claude
+
+Now you can ask Claude to query your data:
+
+> "Show me revenue by region for the last month"
+
+> "What are the top 10 customers by order count?"
+
+> "List all available datasets"
+
+## Available Tools
+
+### `list_datasets`
+
+Lists all available datasets with their descriptions.
+
+**Example:**
+```typescript
+{
+  "name": "list_datasets"
+}
+```
+
+**Response:**
+```json
+{
+  "datasets": [
+    {
+      "name": "orders",
+      "description": "Customer orders and revenue data",
+      "dimensionCount": 5,
+      "metricCount": 4
+    }
+  ],
+  "total": 1
+}
+```
+
+### `get_dataset_schema`
+
+Gets the complete schema for a dataset.
+
+**Example:**
+```typescript
+{
+  "name": "get_dataset_schema",
+  "arguments": {
+    "dataset": "orders"
+  }
+}
+```
+
+**Response:**
+```json
+{
+  "name": "orders",
+  "dimensions": {
+    "region": { "type": "string", "label": "Region" },
+    "status": { "type": "string", "label": "Order Status" }
+  },
+  "metrics": {
+    "revenue": { "type": "sum", "label": "Total Revenue", "format": "currency" }
+  }
+}
+```
+
+### `query_metric`
+
+Executes a pre-defined metric query.
+
+**Example:**
+```typescript
+{
+  "name": "query_metric",
+  "arguments": {
+    "dataset": "orders",
+    "metric": "revenue",
+    "dimensions": ["region"],
+    "filters": [
+      { "field": "status", "operator": "eq", "value": "completed" }
+    ],
+    "grain": "month",
+    "orderBy": [
+      { "field": "revenue", "direction": "desc" }
+    ],
+    "limit": 10
+  }
+}
+```
+
+**Response:**
+```json
+{
+  "data": [
+    { "region": "US", "month": "2024-01", "revenue": 125000 },
+    { "region": "EU", "month": "2024-01", "revenue": 98000 }
+  ],
+  "meta": {
+    "sql": "SELECT...",
+    "timingMs": 45,
+    "rowCount": 2
+  }
+}
+```
+
+### `query_dataset`
+
+Executes an ad-hoc dataset query with custom dimensions and metrics.
+
+**Example:**
+```typescript
+{
+  "name": "query_dataset",
+  "arguments": {
+    "dataset": "orders",
+    "dimensions": ["region", "status"],
+    "metrics": ["revenue", "orderCount"],
+    "limit": 100
+  }
+}
+```
+
+## Programmatic Usage
+
+You can also use the MCP server programmatically in your application:
+
+```typescript
+import { createMCPServer } from '@hypequery/mcp';
+import { MetricExecutor } from '@hypequery/datasets';
+import { datasets } from './datasets/index.js';
+import { queryBuilder } from './db/index.js';
+
+const executor = new MetricExecutor({ builderFactory: queryBuilder });
+
+const server = await createMCPServer({
+  datasets,
+  executor,
+  name: 'my-analytics-mcp',
+  version: '1.0.0',
+});
+
+// Server is now running via stdio transport
+```
+
+## Filter Operators
+
+- `eq`: Equal to
+- `neq`: Not equal to
+- `gt`: Greater than
+- `gte`: Greater than or equal to
+- `lt`: Less than
+- `lte`: Less than or equal to
+- `in`: In list
+- `notIn`: Not in list
+- `between`: Between two values
+- `like`: Pattern match (SQL LIKE)
+
+## Time Grains
+
+- `day`: Daily aggregation
+- `week`: Weekly aggregation
+- `month`: Monthly aggregation
+- `quarter`: Quarterly aggregation
+- `year`: Yearly aggregation
+
+## Prompts
+
+The MCP server also exposes a `dataset_guide` prompt that provides natural language guidance for querying datasets.
+
+## Environment Variables
+
+Your config file can use environment variables for database credentials:
+
+```typescript
+const queryBuilder = createQueryBuilder({
+  host: process.env.CLICKHOUSE_HOST || 'localhost',
+  username: process.env.CLICKHOUSE_USER || 'default',
+  password: process.env.CLICKHOUSE_PASSWORD,
+  database: process.env.CLICKHOUSE_DATABASE || 'default',
+});
+```
+
+## Troubleshooting
+
+### MCP server not connecting
+
+1. Check that the config file path is absolute, not relative
+2. Ensure the config file exports both `datasets` and `executor`
+3. Check Claude Desktop logs for errors
+
+### Queries failing
+
+1. Verify your ClickHouse connection is working
+2. Check that dataset definitions match your database schema
+3. Use the `meta.sql` field in responses to debug generated SQL
+
+## Related Packages
+
+- `@hypequery/datasets` - Semantic layer DSL
+- `@hypequery/clickhouse` - ClickHouse query builder
+- `@hypequery/serve` - HTTP server for analytics endpoints
+
+## License
+
+Apache-2.0

package/dist/bin.d.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+/**
+ * MCP Server CLI
+ *
+ * This is a standalone executable that starts the MCP server.
+ * Users can configure it by creating a config file that exports datasets and executor.
+ *
+ * Usage:
+ *   npx hypequery-mcp --config ./mcp-config.js
+ */
+export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AAEA;;;;;;;;GAQG"}

package/dist/bin.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+/**
+ * MCP Server CLI
+ *
+ * This is a standalone executable that starts the MCP server.
+ * Users can configure it by creating a config file that exports datasets and executor.
+ *
+ * Usage:
+ *   npx hypequery-mcp --config ./mcp-config.js
+ */
+import { createMCPServer } from './server.js';
+import { pathToFileURL } from 'url';
+import { resolve } from 'path';
+import { format } from 'util';
+function routeConsoleOutputToStderr() {
+    const write = (...args) => {
+        process.stderr.write(`${format(...args)}\n`);
+    };
+    // MCP stdio transport owns stdout. Keep application and query logs off the
+    // protocol stream, including logs emitted while loading the user's config.
+    console.log = write;
+    console.info = write;
+    console.debug = write;
+}
+async function main() {
+    routeConsoleOutputToStderr();
+    const args = process.argv.slice(2);
+    const configIndex = args.indexOf('--config');
+    if (configIndex === -1 || !args[configIndex + 1]) {
+        console.error('Error: --config flag is required');
+        console.error('');
+        console.error('Usage: hypequery-mcp --config ./mcp-config.js');
+        console.error('');
+        console.error('The config file should export { datasets, executor }:');
+        console.error('');
+        console.error('  export const datasets = { ... };');
+        console.error('  export const executor = new MetricExecutor(...);');
+        process.exit(1);
+    }
+    const configPath = resolve(process.cwd(), args[configIndex + 1]);
+    try {
+        // Dynamic import of the config file
+        const configModule = await import(pathToFileURL(configPath).href);
+        const { datasets, executor } = configModule;
+        if (!datasets) {
+            throw new Error('Config file must export "datasets"');
+        }
+        if (!executor) {
+            throw new Error('Config file must export "executor"');
+        }
+        // Create and start the MCP server
+        await createMCPServer({
+            datasets,
+            executor,
+            name: 'hypequery-mcp-server',
+            version: '0.1.0',
+        });
+        // Keep the process running
+        process.on('SIGINT', () => {
+            console.error('Shutting down MCP server...');
+            process.exit(0);
+        });
+    }
+    catch (error) {
+        console.error('Error loading config file:', error);
+        process.exit(1);
+    }
+}
+main().catch((error) => {
+    console.error('Fatal error:', error);
+    process.exit(1);
+});

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @hypequery/mcp
+ *
+ * Model Context Protocol (MCP) server for Hypequery semantic layer.
+ * Exposes datasets and metrics to AI agents via MCP tools.
+ */
+export { HypequeryMCPServer, createMCPServer, type MCPServerConfig } from './server.js';
+export { listDatasetsTool } from './tools/list-datasets.js';
+export { getDatasetSchemaTool } from './tools/introspect.js';
+export { queryMetricTool } from './tools/query-metric.js';
+export { queryDatasetTool } from './tools/query-dataset.js';
+export { datasetGuidePrompt } from './prompts/dataset-guide.js';
+export type { DatasetRegistry, QueryMetricArgs, QueryDatasetArgs, GetDatasetSchemaArgs, MCPToolResponse, DatasetSchema, DimensionSchema, MetricSchema, RelationshipSchema, DatasetListItem, DatasetsListResponse, QueryResultResponse, QueryResultMeta, } from './types.js';
+export { MAX_QUERY_LIMIT, DEFAULT_QUERY_LIMIT } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAGhE,YAAY,EACV,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,aAAa,EACb,eAAe,EACf,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,13 @@
+/**
+ * @hypequery/mcp
+ *
+ * Model Context Protocol (MCP) server for Hypequery semantic layer.
+ * Exposes datasets and metrics to AI agents via MCP tools.
+ */
+export { HypequeryMCPServer, createMCPServer } from './server.js';
+export { listDatasetsTool } from './tools/list-datasets.js';
+export { getDatasetSchemaTool } from './tools/introspect.js';
+export { queryMetricTool } from './tools/query-metric.js';
+export { queryDatasetTool } from './tools/query-dataset.js';
+export { datasetGuidePrompt } from './prompts/dataset-guide.js';
+export { MAX_QUERY_LIMIT, DEFAULT_QUERY_LIMIT } from './types.js';

package/dist/prompts/dataset-guide.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Dataset Guide Prompt
+ *
+ * Provides natural language guidance for querying datasets.
+ */
+import type { DatasetRegistry } from '../types.js';
+export declare function datasetGuidePrompt(datasets: DatasetRegistry, datasetName?: string): {
+    messages: {
+        role: "user";
+        content: {
+            type: "text";
+            text: string;
+        };
+    }[];
+};
+//# sourceMappingURL=dataset-guide.d.ts.map

package/dist/prompts/dataset-guide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataset-guide.d.ts","sourceRoot":"","sources":["../../src/prompts/dataset-guide.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,eAAe,EAAE,WAAW,CAAC,EAAE,MAAM;;;;;;;;EAmIjF"}