fix: standardize tool description formatting with string concatenation

jirispilka · jirispilka · commit d78d12a99a45 · 2025-07-29T09:29:21.000+02:00
Replace inconsistent template literal indentation with string concatenation
for all tool descriptions to ensure clean code and output text.
diff --git a/src/tools/actor.ts b/src/tools/actor.ts
@@ -330,12 +330,12 @@ export const callActor: ToolEntry = {
                 return {
                     content: [{
                         type: 'text',
-                        text: `Actor '${actorName}' is not added. ${toolsText}
-To use this MCP server, specify the actors with the parameter, for example:
-?actors=apify/instagram-scraper,apify/website-content-crawler
-or with the CLI:
---actors "apify/instagram-scraper,apify/website-content-crawler"
-You can only use actors that are included in the list; actors not in the list cannot be used.`,
+                        text: `Actor '${actorName}' is not added. ${toolsText}\n`
+                            + 'To use this MCP server, specify the actors with the parameter, for example:\n'
+                            + '?actors=apify/instagram-scraper,apify/website-content-crawler\n'
+                            + 'or with the CLI:\n'
+                            + '--actors "apify/instagram-scraper,apify/website-content-crawler"\n'
+                            + 'You can only use actors that are included in the list; actors not in the list cannot be used.',
                     }],
                 };
             }
diff --git a/src/tools/get-actor-details.ts b/src/tools/get-actor-details.ts
@@ -46,10 +46,15 @@ export const getActorDetailsTool: ToolEntry = {
     type: 'internal',
     tool: {
         name: HelperTools.ACTOR_GET_DETAILS,
-        description: `Retrieve information about an Actor by its ID or full name.
-The Actor name is always composed of "username/name", for example, "apify/rag-web-browser".
-This tool returns information about the Actor, including whether it is public or deprecated, when it was created or modified, the categories in which the Actor is listed, a description, a README (the Actor's documentation), the input schema, and usage statistics - such as how many users are using it and the number of failed runs of the Actor.
-For example, use this tool when a user wants to know more about a specific Actor or wants to use optional or advanced parameters of the Actor that are not listed in the default Actor tool input schema - so you know the details and how to pass them.`,
+        description: `Retrieve information about an Actor by its ID or full name.\n`
+            + 'The Actor name is always composed of "username/name", for example, "apify/rag-web-browser".\n'
+            + 'This tool returns information about the Actor, including whether it is public or deprecated, '
+            + 'when it was created or modified, the categories in which the Actor is listed, a description, '
+            + 'a README (the Actor\'s documentation), the input schema, and usage statistics - such as how many users are using it '
+            + 'and the number of failed runs of the Actor.\n'
+            + 'For example, use this tool when a user wants to know more about a specific Actor or wants to use optional '
+            + 'or advanced parameters of the Actor that are not listed in the default Actor tool input schema - '
+            + 'so you know the details and how to pass them.',
         inputSchema: zodToJsonSchema(getActorDetailsToolArgsSchema),
         ajvValidate: ajv.compile(zodToJsonSchema(getActorDetailsToolArgsSchema)),
         call: async (toolArgs) => {
diff --git a/src/tools/helpers.ts b/src/tools/helpers.ts
@@ -39,13 +39,12 @@ export const addTool: ToolEntry = {
     type: 'internal',
     tool: {
         name: HelperTools.ACTOR_ADD,
-        description:
-            `Add an Actor or MCP server to the available tools of the Apify MCP server. 
-A tool is an Actor or MCP server that can be called by the user. 
-Do not execute the tool, only add it and list it in the available tools. 
-For example, when a user wants to scrape a website, first search for relevant Actors
-using ${HelperTools.STORE_SEARCH} tool, and once the user selects one they want to use, 
-add it as a tool to the Apify MCP server.`,
+        description: `Add an Actor or MCP server to the available tools of the Apify MCP server.\n`
+            + 'A tool is an Actor or MCP server that can be called by the user.\n'
+            + 'Do not execute the tool, only add it and list it in the available tools.\n'
+            + 'For example, when a user wants to scrape a website, first search for relevant Actors\n'
+            + `using ${HelperTools.STORE_SEARCH} tool, and once the user selects one they want to use,\n`
+            + 'add it as a tool to the Apify MCP server.',
         inputSchema: zodToJsonSchema(addToolArgsSchema),
         ajvValidate: ajv.compile(zodToJsonSchema(addToolArgsSchema)),
         // TODO: I don't like that we are passing apifyMcpServer and mcpServer to the tool
@@ -120,9 +119,10 @@ export const helpTool: ToolEntry = {
     type: 'internal',
     tool: {
         name: HelperTools.APIFY_MCP_HELP_TOOL,
-        description: `Helper tool to get information on how to use and troubleshoot the Apify MCP server.
-This tool always returns the same help message with information about the server and how to use it.
-ALWAYS CALL THIS TOOL AT THE BEGINNING OF THE CONVERSATION SO THAT YOU HAVE INFORMATION ABOUT THE APIFY MCP SERVER IN CONTEXT, OR WHEN YOU ENCOUNTER ANY ISSUES WITH THE MCP SERVER OR ITS TOOLS.`,
+        description: `Helper tool to get information on how to use and troubleshoot the Apify MCP server.\n`
+            + 'This tool always returns the same help message with information about the server and how to use it.\n'
+            + 'ALWAYS CALL THIS TOOL AT THE BEGINNING OF THE CONVERSATION SO THAT YOU HAVE INFORMATION ABOUT THE APIFY MCP SERVER IN CONTEXT, '
+            + 'OR WHEN YOU ENCOUNTER ANY ISSUES WITH THE MCP SERVER OR ITS TOOLS.',
         inputSchema: zodToJsonSchema(helpToolArgsSchema),
         ajvValidate: ajv.compile(zodToJsonSchema(helpToolArgsSchema)),
         call: async () => {
diff --git a/src/tools/run_collection.ts b/src/tools/run_collection.ts
@@ -32,9 +32,9 @@ export const getUserRunsList: ToolEntry = {
     tool: {
         name: HelperTools.ACTOR_RUN_LIST_GET,
         actorFullName: HelperTools.ACTOR_RUN_LIST_GET,
-        description: `Gets a paginated list of Actor runs with run details, datasetId, and keyValueStoreId.
-           Filter by status: READY (not allocated), RUNNING (executing), SUCCEEDED (finished), FAILED (failed),
-           TIMING-OUT (timing out), TIMED-OUT (timed out), ABORTING (being aborted), ABORTED (aborted).`,
+        description: `Gets a paginated list of Actor runs with run details, datasetId, and keyValueStoreId.\n`
+            + 'Filter by status: READY (not allocated), RUNNING (executing), SUCCEEDED (finished), FAILED (failed),\n'
+            + 'TIMING-OUT (timing out), TIMED-OUT (timed out), ABORTING (being aborted), ABORTED (aborted).',
         inputSchema: zodToJsonSchema(getUserRunsListArgs),
         ajvValidate: ajv.compile(zodToJsonSchema(getUserRunsListArgs)),
         call: async (toolArgs) => {
diff --git a/src/tools/search-apify-docs.ts b/src/tools/search-apify-docs.ts
@@ -30,9 +30,12 @@ export const searchApifyDocsTool: ToolEntry = {
     type: 'internal',
     tool: {
         name: HelperTools.DOCS_SEARCH,
-        description: `Apify documentation search tool. This tool allows you to search the Apify documentation using Algolia's full-text search.
-You can use it to find relevant documentation pages based on keywords. The results will include the URL of the documentation page, a fragment identifier (if available), and a limited piece of content that matches the search query. You can then fetch the full content of the document using the ${HelperTools.DOCS_FETCH} tool by providing the URL.
-Use this tool when a user asks for help with Apify documentation or when you need to find relevant documentation pages based on keywords. For example, when a user wants to build an Apify Actor, you can search "How to build Actors" to find relevant guidance.`,
+        description: `Apify documentation search tool. This tool allows you to search the Apify documentation using Algolia's full-text search.\n`
+            + 'You can use it to find relevant documentation pages based on keywords. The results will include the URL of the documentation page, '
+            + 'a fragment identifier (if available), and a limited piece of content that matches the search query. '
+            + `You can then fetch the full content of the document using the ${HelperTools.DOCS_FETCH} tool by providing the URL.\n`
+            + 'Use this tool when a user asks for help with Apify documentation or when you need to find relevant documentation pages based on keywords. '
+            + 'For example, when a user wants to build an Apify Actor, you can search "How to build Actors" to find relevant guidance.',
         args: searchApifyDocsToolArgsSchema,
         inputSchema: zodToJsonSchema(searchApifyDocsToolArgsSchema),
         ajvValidate: ajv.compile(zodToJsonSchema(searchApifyDocsToolArgsSchema)),
diff --git a/src/tools/store_collection.ts b/src/tools/store_collection.ts
@@ -97,13 +97,14 @@ export const searchActors: ToolEntry = {
     type: 'internal',
     tool: {
         name: HelperTools.STORE_SEARCH,
-        description: `Discover available Actors or MCP servers (which are also considered Actors in the context of Apify) in the Apify Store.
-This tool uses full-text search, so you MUST use simple space-separated keywords, such as "web scraping", "data extraction", or "playwright browser mcp".
-This tool returns a list of Actors with basic information, including descriptions, pricing models, usage statistics, and user ratings.
-Prefer Actors with more users, stars, and runs.
-You may need to use this tool several times to find the right Actor.
-Limit the number of results returned, but ensure that relevant results are included.
-This is not a general search tool; it is designed specifically to search for Actors in the Apify Store.`,
+        description: `Discover available Actors or MCP servers (which are also considered Actors in the context of Apify) in the Apify Store.\n`
+            + 'This tool uses full-text search, so you MUST use simple space-separated keywords, such as "web scraping", '
+            + '"data extraction", or "playwright browser mcp".\n'
+            + 'This tool returns a list of Actors with basic information, including descriptions, pricing models, usage statistics, and user ratings.\n'
+            + 'Prefer Actors with more users, stars, and runs.\n'
+            + 'You may need to use this tool several times to find the right Actor.\n'
+            + 'Limit the number of results returned, but ensure that relevant results are included.\n'
+            + 'This is not a general search tool; it is designed specifically to search for Actors in the Apify Store.',
         inputSchema: zodToJsonSchema(searchActorsArgsSchema),
         ajvValidate: ajv.compile(zodToJsonSchema(searchActorsArgsSchema)),
         call: async (toolArgs) => {
