tidewave 0.1.0 → 0.3.0

package/README.md

@@ -20,7 +20,7 @@ Simply configure your editor to run `tidewave` in the same directory as your
 
 ```bash
 npx tidewave mcp
-# or
+# or with Bun
 bunx tidewave mcp
 # or with Deno
 deno run npm:tidewave mcp
@@ -30,6 +30,96 @@ Available MCP options:
 
 - `--prefix path` - Specify the directory to find the `package.json` file
 
+### HTTP MCP via Vite Plugin
+
+Tidewave also provides HTTP-based MCP access through a Vite plugin for
+development environments. Add the plugin to your `vite.config.js`:
+
+```javascript
+import { defineConfig } from 'vite';
+import tidewave from 'tidewave/vite-plugin';
+
+export default defineConfig({
+  plugins: [tidewave()],
+});
+```
+
+This exposes MCP endpoints at `/tidewave/mcp` and `/tidewave/shell` during
+development.
+
+Configuration options:
+
+```javascript
+tidewave({
+  allowRemoteAccess: false, // Allow access from remote IPs
+  allowedOrigins: ['localhost'], // Allowed origins: defaults to the Vite's host+port
+});
+```
+
+### HTTP MCP via Next.js Integration
+
+Tidewave provides seamless integration with Next.js through a handler function.
+Add the handler to your API routes **and** `middleware.ts`:
+
+> [!WARNING] Note that the below helper functions will only work on development
+> mode `NODE_ENV === 'development'` if the validation fails, an Error will be
+> thrown
+
+**Pages Router** - Create `pages/api/tidewave/[...all].ts`:
+
+```typescript
+import { tidewaveHandler } from 'tidewave/next-js';
+
+export default await tidewaveHandler();
+
+// Next.js specific config
+export const config = {
+  runtime: 'nodejs',
+  api: {
+    bodyParser: false, // tidewave already parses the body internally
+  },
+};
+```
+
+This exposes MCP endpoints at `/api/tidewave/mcp` and `/api/tidewave/shell`.
+
+Then create `middleware.ts` with:
+
+```typescript
+import { tidewaveMiddleware } from 'tidewave/next-js';
+
+export const middleware = tidewaveMiddleware();
+
+export const config = {
+  matcher: '/tidewave/(.*)',
+};
+```
+
+In case you already have an existing `middleware.ts`:
+
+```typescript
+import { tidewaveMiddleware } from 'tidewave/next-js';
+
+const withTidewave = tidewaveMiddleware();
+
+export function middleware(req: NextRequest): Promise<NextResponse> {
+  // This will return a unchanged NextResponse.next()
+  // if path doesn't match with `/tidewave`
+  // if does match it will rewrite to `/api/tidewave` instead
+  withTidewave(req, (req: NextRequest) => {
+    // your own logic
+    return NextResponse.json({ message: 'hello, world!' });
+  });
+}
+
+export const config = {
+  matcher: [
+    '/tidewave/(.*)', // tidewave specific matcher
+    '/your/route/', // your specific matcher
+  ],
+};
+```
+
 ### CLI Usage
 
 Tidewave also provides the MCP features over a CLI tool. Use it directly via

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};