Skip to content

Commit 9855f58

Browse files
jirispilkajirispilka
committed
fix: move tool text into a constant
1 parent c54bd4d commit 9855f58

File tree

1 file changed

+51
-54
lines changed

1 file changed

+51
-54
lines changed

‎src/tools/helpers.ts‎

Lines changed: 51 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,55 @@ import { getActorsAsTools } from './actor.js';
88
import { actorNameToToolName } from './utils.js';
99

1010
const ajv = new Ajv({ coerceTypes: 'array', strict: false });
11+
12+
const HELP_TOOL_TEXT = `Apify MCP server help:
13+
14+
Note: "MCP" stands for "Model Context Protocol". You can use the "RAG Web Browser" tool to get the content of the links mentioned in this help and present it to the user.
15+
16+
This MCP server can be used in the following ways:
17+
- Locally over "STDIO"
18+
- Remotely over "SSE" or streamable "HTTP" transport with the "Actors MCP Server Apify Actor"
19+
- Remotely over "SSE" or streamable "HTTP" transport with "https://mcp.apify.com"
20+
21+
# Usage
22+
## Locally over "STDIO"
23+
1. The user should install the "@apify/actors-mcp-server" NPM package.
24+
2. The user should configure their MCP client to use the MCP server. Refer to "https://github.com/apify/actors-mcp-server" or the MCP client documentation for more details (you can ask the user which MCP client they are using).
25+
The user needs to set the following environment variables:
26+
- "APIFY_TOKEN": Apify token to authenticate with the MCP server.
27+
If the user wants to load some Actors outside the default ones, he needs to pass them as CLI arguments:
28+
- "--actors <actor1,actor2,...>" // comma-separated list of Actor names, for example, "apify/rag-web-browser,apify/instagram-scraper".
29+
If the user wants to enable the dynamic addition of Actors to the MCP server, he needs to pass the following CLI argument:
30+
- "--enable-adding-actors"
31+
32+
## Remotely over "SSE" or streamable "HTTP" transport with "Actors MCP Server Apify Actor"
33+
1. The user should configure their MCP client to use the "Actors MCP Server Apify Actor" with
34+
"SSE" transport URL: "https://actors-mcp-server.apify.actor/sse" or Streamable "HTTP" transport URL: "https://actors-mcp-server.apify.actor/mcp"
35+
2. The user needs to pass a "APIFY_TOKEN" as a URL query parameter "?token=<APIFY_TOKEN>" or set the following headers: "Authorization: Bearer <APIFY_TOKEN>"
36+
If the user wants to load some Actors outside the default ones, the user needs to pass them as URL query parameters:
37+
- "?actors=<actor1,actor2,...>" // comma-separated list of Actor names, for example, "apify/rag-web-browser,apify/instagram-scraper"
38+
If the user wants to enable the addition of Actors to the MCP server dynamically, the user needs to pass the following URL query parameter:
39+
- "?enable-adding-actors=true"
40+
41+
## Remotely over "SSE" or streamable "HTTP" transport with "https://mcp.apify.com"
42+
1. The user should configure their MCP client to use "https://mcp.apify.com" with "SSE" transport URL: "https://mcp.apify.com/sse" or Streamable "HTTP" transport URL: "https://mcp.apify.com/"
43+
2. The user needs to pass a "APIFY_TOKEN" as a URL query parameter "?token=<APIFY_TOKEN>" or set the following headers: "Authorization: Bearer <APIFY_TOKEN>"
44+
If the user wants to load some Actors outside the default ones, the user needs to pass them as URL query parameters:
45+
- "?actors=<actor1,actor2,...>" // comma-separated list of Actor names, for example, "apify/rag-web-browser,apify/instagram-scraper"
46+
If the user wants to enable the addition of Actors to the MCP server dynamically, the user needs to pass the following URL query parameter:
47+
- "?enable-adding-actors=true"
48+
49+
# Features
50+
## Dynamic adding of Actors
51+
THIS FEATURE MAY NOT BE SUPPORTED BY ALL MCP CLIENTS. THE USER MUST ENSURE THAT THE CLIENT SUPPORTS IT!
52+
To enable this feature, see the usage section. Once dynamic adding is enabled, tools will be added that allow you to add or remove Actors from the MCP server.
53+
Tools related:
54+
- "add-actor"
55+
- "remove-actor"
56+
In case you are using these tools and it seems like the tools have been added but you cannot call them, the issue may be that the client does not support dynamic adding of Actors.
57+
In that case, please inform the user that the MCP client documentation should be checked to see if the client supports this feature.
58+
`;
59+
1160
export const AddToolArgsSchema = z.object({
1261
actorName: z.string()
1362
.describe('Add a tool, Actor or MCP-Server to available tools by Actor ID or tool full name.'
@@ -77,60 +126,8 @@ export const helpTool: ToolWrap = {
77126
inputSchema: zodToJsonSchema(HelpToolArgsSchema),
78127
ajvValidate: ajv.compile(zodToJsonSchema(HelpToolArgsSchema)),
79128
call: async () => {
80-
return { content: [{
81-
type: 'text',
82-
text: `Apify MCP server help:
83-
84-
Note: MCP stands for Model Context Protocol. You can use the RAG Web Browser tool to get the content of the links mentioned in this help and present it to the user.
85-
86-
This MCP server can be used in the following ways:
87-
- Locally over STDIO
88-
- Remotely over SSE or streamable HTTP transport with the Actors MCP Server Apify Actor
89-
- Remotely over SSE or streamable HTTP transport with mcp.apify.com
90-
91-
# Usage
92-
## Locally over STDIO
93-
1. The user should install the @apify/actors-mcp-server NPM package.
94-
2. The user should configure their MCP client to use the MCP server. Refer to https://github.com/apify/actors-mcp-server or the MCP client documentation for more details (you can ask the user which MCP client they are using).
95-
The user needs to set the following environment variables:
96-
- APIFY_TOKEN: Apify token to authenticate with the MCP server.
97-
If the user wants to load some Actors outside of the default ones, they need to pass them as CLI arguments:
98-
- --actors <actor1,actor2,...> // comma-separated list of Actor names, for example, apify/rag-web-browser,apify/instagram-scraper.
99-
If the user wants to enable the dynamic addition of Actors to the MCP server, they need to pass the following CLI argument:
100-
- --enable-adding-actors
101-
102-
## Remotely over SSE or streamable HTTP transport with Actors MCP Server Apify Actor
103-
1. The user should configure their MCP client to use the Actors MCP Server Apify Actor.
104-
SSE transport URL: https://actors-mcp-server.apify.actor/sse
105-
Streamable HTTP transport URL: https://actors-mcp-server.apify.actor/mcp
106-
The user needs to set the following headers or pass ?token=<APIFY_TOKEN> as a URL query parameter:
107-
- Authorization: Bearer <APIFY_TOKEN>
108-
If the user wants to load some Actors outside of the default ones, they need to pass them as URL query parameters:
109-
- ?actors=<actor1,actor2,...> // comma-separated list of Actor names, for example, apify/rag-web-browser,apify/instagram-scraper
110-
If the user wants to enable the addition of Actors to the MCP server dynamically, they need to pass the following URL query parameter:
111-
- ?enableAddingActors=true
112-
113-
## Remotely over SSE or streamable HTTP transport with mcp.apify.com
114-
1. The user should configure their MCP client to use mcp.apify.com.
115-
SSE transport URL: https://mcp.apify.com/sse
116-
Streamable HTTP transport URL: https://mcp.apify.com/
117-
The user needs to set the following headers or pass ?token=<APIFY_TOKEN> as a URL query parameter:
118-
- Authorization: Bearer <APIFY_TOKEN>
119-
If the user wants to load some Actors outside of the default ones, they need to pass them as URL query parameters:
120-
- ?actors=<actor1,actor2,...> // comma-separated list of Actor names, for example, apify/rag-web-browser,apify/instagram-scraper
121-
If the user wants to enable the addition of Actors to the MCP server dynamically, they need to pass the following URL query parameter:
122-
- ?enableAddingActors=true
123-
124-
# Features
125-
## Dynamic Adding of Actors
126-
THIS FEATURE MAY NOT BE SUPPORTED BY ALL MCP CLIENTS. THE USER MUST ENSURE THAT THE CLIENT SUPPORTS IT!
127-
To enable this feature, see the usage section. Once dynamic adding is enabled, tools will be added that allow you to add or remove Actors from the MCP server.
128-
Tools related:
129-
- add-actor
130-
- remove-actor
131-
In case you are using these tools and it seems like the tools have been added but you cannot call them, the issue may be that the client does not support dynamic adding of Actors. In that case, please inform the user that the MCP client documentation should be checked to see if the client supports this feature.
132-
`,
133-
}] };
129+
return { content: [{ type: 'text', text: HELP_TOOL_TEXT }] };
134130
},
135131
} as InternalTool,
136132
};
133+

0 commit comments

Comments
 (0)