@topgunbuild/mcp-server 0.9.0

package/LICENSE

@@ -0,0 +1,97 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             TopGun Contributors
+Licensed Work:        TopGun
+                      The Licensed Work is (c) 2024 TopGun Contributors.
+Additional Use Grant: You may make production use of the Licensed Work,
+                      provided Your use does not include offering the
+                      Licensed Work to third parties as a commercial
+                      managed database service, database-as-a-service,
+                      or similar hosted database offering that competes
+                      with TopGun products or services.
+
+                      For purposes of this license:
+                      - "Managed database service" means a service that
+                        allows third parties to create, manage, or operate
+                        databases using TopGun as the underlying technology.
+                      - Internal use within your organization is permitted.
+                      - Using TopGun as part of your application's backend
+                        (not exposed as a database service) is permitted.
+                      - Consulting and professional services around TopGun
+                        are permitted.
+
+Change Date:          Four years from the date of each version release
+Change License:       Apache License, Version 2.0
+
+For information about alternative licensing arrangements for the Licensed Work,
+please contact the Licensor.
+
+Notice
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an Additional Use Grant (above) that does not impose
+   any additional restriction on the right granted in this License, as the
+   Additional Use Grant; or (b) insert the text "None" to specify a Change Date.
+
+3. Not to modify this License in any other way.

package/README.md

@@ -0,0 +1,199 @@
+# @topgunbuild/mcp-server
+
+MCP (Model Context Protocol) Server for TopGun - enables AI assistants like Claude Desktop and Cursor to interact with TopGun databases through natural language.
+
+## What is MCP?
+
+MCP (Model Context Protocol) is Anthropic's open protocol for connecting AI assistants to external data sources. It allows AI tools to query, modify, and search your TopGun database using natural language.
+
+## Installation
+
+```bash
+npm install @topgunbuild/mcp-server
+# or
+pnpm add @topgunbuild/mcp-server
+```
+
+## Quick Start
+
+### Claude Desktop
+
+1. Install the MCP server globally:
+```bash
+npm install -g @topgunbuild/mcp-server
+```
+
+2. Configure Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+```json
+{
+  "mcpServers": {
+    "topgun": {
+      "command": "npx",
+      "args": ["@topgunbuild/mcp-server"],
+      "env": {
+        "TOPGUN_URL": "ws://localhost:8080"
+      }
+    }
+  }
+}
+```
+
+3. Restart Claude Desktop
+
+4. Try: "Show me all tasks in my TopGun database"
+
+### Cursor
+
+Add to `.cursor/config.json` in your workspace:
+
+```json
+{
+  "mcp": {
+    "servers": {
+      "topgun": {
+        "command": "npx",
+        "args": ["@topgunbuild/mcp-server"],
+        "env": {
+          "TOPGUN_URL": "ws://localhost:8080"
+        }
+      }
+    }
+  }
+}
+```
+
+### Programmatic Usage
+
+```typescript
+import { TopGunMCPServer } from '@topgunbuild/mcp-server';
+
+const server = new TopGunMCPServer({
+  topgunUrl: 'ws://localhost:8080',
+  allowedMaps: ['tasks', 'users'],
+  enableMutations: true,
+  debug: true,
+});
+
+await server.start();
+```
+
+## CLI Options
+
+```bash
+topgun-mcp [options]
+
+Options:
+  --url, -u <url>         TopGun server URL (default: ws://localhost:8080)
+  --token, -t <token>     Authentication token
+  --maps, -m <maps>       Comma-separated list of allowed maps
+  --no-mutations          Disable mutation operations
+  --no-subscriptions      Disable subscription operations
+  --http                  Start HTTP transport instead of stdio
+  --port, -p <port>       HTTP port (default: 3000)
+  --debug, -d             Enable debug logging
+  --help, -h              Show help
+  --version, -v           Show version
+```
+
+## Available Tools
+
+### topgun_list_maps
+List all available maps.
+
+### topgun_query
+Query data from a map with filters and sorting.
+
+```
+Example: "Show me all tasks with status 'done'"
+```
+
+### topgun_mutate
+Create, update, or delete data.
+
+```
+Example: "Create a task called 'Review PR #123'"
+```
+
+### topgun_search
+Perform hybrid search (BM25 full-text + exact matching).
+
+```
+Example: "Find tasks about authentication"
+```
+
+### topgun_subscribe
+Watch a map for real-time changes.
+
+```
+Example: "Watch for new high-priority tasks"
+```
+
+### topgun_schema
+Get schema information about a map.
+
+```
+Example: "What fields does the tasks map have?"
+```
+
+### topgun_stats
+Get statistics about TopGun connection and maps.
+
+```
+Example: "What's the status of my TopGun connection?"
+```
+
+### topgun_explain
+Explain how a query would be executed.
+
+```
+Example: "Explain query on tasks where status='done'"
+```
+
+## Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `topgunUrl` | string | `ws://localhost:8080` | TopGun server WebSocket URL |
+| `authToken` | string | - | Authentication token |
+| `allowedMaps` | string[] | - | Restrict to specific maps (all by default) |
+| `enableMutations` | boolean | `true` | Allow write operations |
+| `enableSubscriptions` | boolean | `true` | Allow subscriptions |
+| `defaultLimit` | number | `10` | Default query result limit |
+| `maxLimit` | number | `100` | Maximum query result limit |
+| `subscriptionTimeoutSeconds` | number | `60` | Subscription timeout |
+| `debug` | boolean | `false` | Enable debug logging |
+
+## HTTP Transport
+
+For web-based MCP clients, you can start the server with HTTP transport:
+
+```bash
+topgun-mcp --http --port 3000
+```
+
+Endpoints:
+- `GET /health` - Health check
+- `GET /mcp` - Server info
+- `GET /mcp/events` - SSE connection
+- `POST /mcp` - Stateless tool calls
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `TOPGUN_URL` | TopGun server URL |
+| `TOPGUN_TOKEN` | Authentication token |
+| `TOPGUN_MAPS` | Comma-separated allowed maps |
+| `TOPGUN_MCP_PORT` | HTTP port (with --http) |
+| `TOPGUN_DEBUG` | Enable debug (true/false) |
+
+## Security
+
+- Use `allowedMaps` to restrict access to specific maps
+- Use `enableMutations: false` for read-only access
+- Use authentication tokens in production
+- The MCP server runs locally - data never leaves your machine
+
+## License
+
+BSL-1.1