Skip to content

Commit 18e05d6

Browse files
committed
Improve tool descriptions, list tools in README
1 parent 41934a9 commit 18e05d6

2 files changed

Lines changed: 19 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,21 @@ options below:
263263
accessed from another trusted machine
264264
- `team`: enable Tidewave Web for teams
265265

266+
## Available tools
267+
268+
* `get_docs` - get the documentation for a given module/namespace or a
269+
class/interface/enum/type in that namespace. It consults the exact
270+
versions used by the project, ensuring you always get correct information
271+
272+
* `get_source_location` - get the source location for a given module/namespace
273+
or a class/interface/enum/type in that namespace, so an agent can directly
274+
read the source skipping search
275+
276+
* `get_logs` - reads console log written by the server
277+
278+
* `project_eval` - evaluates code within the runtime itself, giving the agent
279+
access to dependencies, server code, and all in-memory data
280+
266281
## CLI
267282

268283
Tidewave.js also comes with a CLI for developers who want to use it as a

src/tools.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ export interface Tools {
2828
}
2929

3030
const projectEvalDescription = `
31-
Evaluates JavaScript/TypeScript code in the context of the project.
31+
Evaluates JavaScript/TypeScript code within your project's build tool
32+
(or server for full-stack applications).
3233
3334
The current NodeJS version is: ${process.version}
3435
@@ -37,7 +38,7 @@ including to test the behaviour of a function or to debug
3738
something. The tool also returns anything written to standard
3839
output. DO NOT use shell tools to evaluate JavaScript/TypeScript code.
3940
40-
Imports are allowed only as the form of dynamic imports with async/await, e.g.:
41+
Imports are allowed only as the form of dynamic imports with async/await:
4142
const path = await import('node:path');
4243
`;
4344

@@ -153,7 +154,7 @@ export const tools: Tools = {
153154
mcp: {
154155
name: 'get_logs',
155156
description:
156-
'Retrieve application logs for debugging. Returns logs excluding Tidewave internal logs. Supports filtering by level, time, and pattern matching.',
157+
"Retrieve application logs within your project's build tool (or server for full-stack applications). Supports filtering by level, time, and pattern matching.",
157158
inputSchema: getLogsInputSchema,
158159
},
159160
},

0 commit comments

Comments
 (0)