Skip to content

Commit da45a6b

Browse files
author
oleina
committed
some in-line docs for the mcp tool
1 parent 9725bbc commit da45a6b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/mcp/tool.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,19 @@ export interface ServerTool<InputSchema extends ZodTypeAny = ZodTypeAny> {
2121
inputSchema: any;
2222
annotations?: {
2323
title?: string;
24+
25+
// If this tool modifies data or not.
2426
readOnlyHint?: boolean;
27+
28+
// this tool can destroy data.
2529
destructiveHint?: boolean;
30+
31+
// this tool is safe to run multiple times.
2632
idempotentHint?: boolean;
33+
34+
// If this is true, it connects to the internet or other open world
35+
// systems. If false, the tool only performs actions in an enclosed
36+
// system, such as your project.
2737
openWorldHint?: boolean;
2838
};
2939
_meta?: {

0 commit comments

Comments
 (0)