Are XML blocks generated by @code_runner supposed to contain CDATA section?

[Bekaboo]

AFAIK this plugin use XML for structured response. When using the @editor tool, the LLM will response with a XML code block which is then parsed by this plugin to modify the contents of the current buffer. The XML code block must always incode the CDATA section, as mentioned in the prompt here:

codecompanion.nvim/lua/codecompanion/helpers/tools/editor.lua

Line 186 in 77e04c5

- **Keep the CDATA** section wrapping the code, the code could contain characters reserved by XML.

For the @code_runner tool, there is no instruction about the CDATA section:

codecompanion.nvim/lua/codecompanion/helpers/tools/code_runner.lua

Line 41 in 77e04c5

system_prompt = function(schema)

So at first I thought that the CDATA section is unneeded for this tool. However when trying it I get an error that the XML file is invalid:

Only after adding the CDATA sections the XML parser can correctly parse the XML:

So I wonder if we can fix this by adding the missing CDATA instruction in the @code_runner tool.

---

Adding "Remember to use CDATA in your XML response." works for me with Claude 3.5 Sonnet as backend:

diff --git a/lua/codecompanion/helpers/tools/code_runner.lua b/lua/codecompanion/helpers/tools/code_runner.lua
index 4fde457..80e91c8 100644
--- a/lua/codecompanion/helpers/tools/code_runner.lua
+++ b/lua/codecompanion/helpers/tools/code_runner.lua
@@ -52,6 +52,7 @@ Usage: To use this tool, you need to return an XML markdown code block (with bac
 ```
 
 You must:
+- Remember to use CDATA in your XML response.
 - Only use the tool when prompted by the user. For example "can you update the code for me?" or "can you add ..."
 - Be mindful that you may not be required to use the tool in all of your responses
 - Ensure the code you're executing will be able to parsed as valid XML

After adding this instruction:

I can open a PR to fix it and provide more detailed information if you wish.

[olimorris]

Yep please raise a PR for this. The code_runner tool will be getting a fix up in the next few weeks but for now please do add