Skip to content

Commit a21acd9

Browse files
committed
fix: helpTool text
1 parent 9855f58 commit a21acd9

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

src/tools/helpers.ts

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,50 +11,53 @@ const ajv = new Ajv({ coerceTypes: 'array', strict: false });
1111

1212
const HELP_TOOL_TEXT = `Apify MCP server help:
1313
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.
14+
Note: "MCP" stands for "Model Context Protocol". The user can use the "RAG Web Browser" tool to get the content of the links mentioned in this help and present it to the user.
1515
1616
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"
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".
2020
2121
# Usage
2222
## Locally over "STDIO"
2323
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).
24+
2. The user should configure the MCP client to use the MCP server. Refer to "https://github.com/apify/actors-mcp-server" or the MCP client documentation for more details (the user can specify which MCP client is being used).
2525
The user needs to set the following environment variables:
2626
- "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:
27+
If the user wants to load an Actor outside the default ones, the user needs to pass it as a CLI argument:
2828
- "--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"
29+
If the user wants to enable the dynamic addition of Actors to the MCP server, the user needs to pass the following CLI argument:
30+
- "--enable-adding-actors".
3131
3232
## 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"
33+
1. The user should configure the MCP client to use the "Actors MCP Server Apify Actor" with:
34+
- "SSE" transport URL: "https://actors-mcp-server.apify.actor/sse".
35+
- Streamable "HTTP" transport URL: "https://actors-mcp-server.apify.actor/mcp".
36+
2. The user needs to pass an "APIFY_TOKEN" as a URL query parameter "?token=<APIFY_TOKEN>" or set the following headers: "Authorization: Bearer <APIFY_TOKEN>".
37+
If the user wants to load an Actor outside the default ones, the user needs to pass it as a URL query parameter:
38+
- "?actors=<actor1,actor2,...>" // comma-separated list of Actor names, for example, "apify/rag-web-browser,apify/instagram-scraper".
3839
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+
- "?enable-adding-actors=true".
4041
4142
## 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"
43+
1. The user should configure the MCP client to use "https://mcp.apify.com" with:
44+
- "SSE" transport URL: "https://mcp.apify.com/sse".
45+
- Streamable "HTTP" transport URL: "https://mcp.apify.com/".
46+
2. The user needs to pass an "APIFY_TOKEN" as a URL query parameter "?token=<APIFY_TOKEN>" or set the following headers: "Authorization: Bearer <APIFY_TOKEN>".
47+
If the user wants to load an Actor outside the default ones, the user needs to pass it as a URL query parameter:
48+
- "?actors=<actor1,actor2,...>" // comma-separated list of Actor names, for example, "apify/rag-web-browser,apify/instagram-scraper".
4649
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"
50+
- "?enable-adding-actors=true".
4851
4952
# Features
5053
## Dynamic adding of Actors
5154
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.
55+
To enable this feature, see the usage section. Once dynamic adding is enabled, tools will be added that allow the user to add or remove Actors from the MCP server.
5356
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.
57+
- "add-actor".
58+
- "remove-actor".
59+
If the user is using these tools and it seems like the tools have been added but cannot be called, the issue may be that the client does not support dynamic adding of Actors.
60+
In that case, the user should check the MCP client documentation to see if the client supports this feature.
5861
`;
5962

6063
export const AddToolArgsSchema = z.object({
@@ -130,4 +133,3 @@ export const helpTool: ToolWrap = {
130133
},
131134
} as InternalTool,
132135
};
133-

0 commit comments

Comments
 (0)