Skip to content

Commit 393a746

Browse files
authored
Update README
Signed-off-by: José Valim <jose.valim@dashbit.co>
1 parent 49bf1d4 commit 393a746

1 file changed

Lines changed: 21 additions & 29 deletions

File tree

README.md

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,24 @@
33
Tidewave is the coding agent for full-stack web app development.
44
[See our website](https://tidewave.ai) for more information.
55

6-
Our current release connects your editor's assistant to your web framework
7-
runtime via [MCP](https://modelcontextprotocol.io/). Support for Tidewave Web
8-
will come in future releases.
6+
This package is recommended for JavaScript-powered backends as
7+
well as JavaScript libraries/applications without a backend.
8+
If you are using React with Phoenix, Rails, Django, or another
9+
server-side framework, [follow the steps here instead](http://hexdocs.pm/tidewave/react.html).
10+
11+
Our current release connects your editor's assistant to JavaScript runtime
12+
via [MCP](https://modelcontextprotocol.io/). Tidewave's MCP server gives
13+
your editor and coding agents access to the documentation, type annotations,
14+
and source file locations of the packages being currently used by your project,
15+
without relying on external systems.
16+
17+
Support for Tidewave Web will come in future releases.
918

1019
## Usage
1120

1221
### Standalone MCP
1322

14-
Tidewave's MCP server gives your editor and coding agents access to the
15-
documentation, type annotations, and source file locations of the packages being
16-
currently used by your project, without relying on external systems.
17-
18-
Simply configure your editor to run `tidewave` in the same directory as your
23+
Configure your editor to run `tidewave` in the same directory as your
1924
`package.json` as a STDIO MCP Server:
2025

2126
```bash
@@ -44,8 +49,7 @@ export default defineConfig({
4449
});
4550
```
4651

47-
This exposes MCP endpoints at `/tidewave/mcp` and `/tidewave/shell` during
48-
development.
52+
This exposes the MCP endpoint at `/tidewave/mcp`.
4953

5054
Configuration options:
5155

@@ -56,14 +60,10 @@ tidewave({
5660
});
5761
```
5862

59-
### HTTP MCP via Next.js Integration
63+
### HTTP MCP for Next.js
6064

61-
Tidewave provides seamless integration with Next.js through a handler function.
62-
Add the handler to your API routes **and** `middleware.ts`:
63-
64-
> [!WARNING] Note that the below helper functions will only work on development
65-
> mode `NODE_ENV === 'development'` if the validation fails, an Error will be
66-
> thrown
65+
Tidewave provides seamless integration with Next.js, you only need to expose its
66+
routes and then plug its middleware accordingly:
6767

6868
**Pages Router** - Create `pages/api/tidewave/[...all].ts`:
6969

@@ -76,14 +76,12 @@ export default await tidewaveHandler();
7676
export const config = {
7777
runtime: 'nodejs',
7878
api: {
79-
bodyParser: false, // tidewave already parses the body internally
79+
bodyParser: false, // Tidewave already parses the body internally
8080
},
8181
};
8282
```
8383

84-
This exposes MCP endpoints at `/api/tidewave/mcp` and `/api/tidewave/shell`.
85-
86-
Then create `middleware.ts` with:
84+
**Middleware** - Then create (or modify) `middleware.ts` with:
8785

8886
```typescript
8987
import { tidewaveMiddleware } from 'tidewave/next-js';
@@ -120,6 +118,8 @@ export const config = {
120118
};
121119
```
122120

121+
This exposes the MCP endpoint at `/tidewave/mcp`.
122+
123123
### CLI Usage
124124

125125
Tidewave also provides the MCP features over a CLI tool. Use it directly via
@@ -149,14 +149,6 @@ npx tidewave source ./src/utils:formatDate
149149
npx tidewave source typescript:createProgram
150150
```
151151

152-
### Runtime Support
153-
154-
Tidewave JavaScript supports multiple JavaScript runtimes:
155-
156-
- **Node.js** - Full support with npm/npx
157-
- **Bun** - Native support with bunx
158-
- **Deno** - Support via npm: protocol
159-
160152
## Contributing
161153

162154
```bash

0 commit comments

Comments
 (0)