Skip to content

Conversation

@neoragex2002
Copy link
Contributor

@neoragex2002 neoragex2002 commented Jun 17, 2025

fix(agent): improve accuracy of semantic descriptions for non-native fc calling

Summary by CodeRabbit

  • Refactor
    • Updated terminology from "tool call result" to "tool call record" across the interface, including changes to JSON keys and related documentation.
    • Improved clarity and consistency in tool call handling instructions and output formatting.
    • Enhanced security and information hiding rules to prevent exposure of internal tool call structures or XML tags in responses.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 17, 2025

Walkthrough

This update standardizes the terminology and formatting for tool call records across the codebase, replacing references to "function_call_result" with "function_call_record." It also strengthens and clarifies documentation and constraints regarding the handling, output, and reuse of tool call records within the LLM provider and related presenters, without altering public APIs.

Changes

File(s) Change Summary
src/main/presenter/llmProviderPresenter/baseProvider.ts Refined documentation and internal string constants: clarified tool call record rules, terminology, and constraints; updated JSON key to function_call_record; expanded usage guidelines.
src/main/presenter/llmProviderPresenter/index.ts Updated non-native tool call handling: renamed variables and comments from "result" to "record"; changed JSON key; adjusted message formatting accordingly.
src/main/presenter/threadPresenter/index.ts Changed JSON serialization in assistant messages from function_call_result to function_call_record.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LLMProviderPresenter
    participant ToolSystem

    User->>LLMProviderPresenter: Sends request
    LLMProviderPresenter->>ToolSystem: Initiates tool call
    ToolSystem-->>LLMProviderPresenter: Returns tool call response
    LLMProviderPresenter->>LLMProviderPresenter: Format as function_call_record JSON
    LLMProviderPresenter->>User: Appends tool call record to conversation, prompts to continue
Loading

Possibly related PRs

Poem

A record, not a result, we now proclaim,
With careful keys, we tidy the name.
No tags revealed, no secrets shown,
Tool calls are logged, but never alone.
The code now clear, the story told—
A rabbit’s hop brings standards bold! 🐇

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/main/presenter/llmProviderPresenter/index.ts (1)

737-742: Inconsistent ChatMessage.content types for user messages
Here you push the user prompt as an array of { type, text } parts, whereas most upstream messages use a plain string. Confirm that downstream serialization/UI supports both formats or normalize on one to avoid potential runtime issues.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 738bc39 and ec0d979.

📒 Files selected for processing (3)
  • src/main/presenter/llmProviderPresenter/baseProvider.ts (2 hunks)
  • src/main/presenter/llmProviderPresenter/index.ts (1 hunks)
  • src/main/presenter/threadPresenter/index.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-check (x64)
🔇 Additional comments (5)
src/main/presenter/llmProviderPresenter/baseProvider.ts (1)

243-245: Down-stream stripping of <function_call> tags is not evident

The new security & information-hiding rules (6-7) forbid any literal exposure of <function_call>/</function_call> tags to the end user.
Inside this class we consume those tags, but the codebase also re-injects raw records back into assistant messages for non-native FC (see threadPresenter/index.ts around 1967-1976).
Please double-check the rendering layer to ensure those injected tags are removed/escaped before reaching the UI; otherwise the new contract is violated.
If no sanitisation exists a thin post-processing hook that strips or masks the tags before display will be required.

src/main/presenter/threadPresenter/index.ts (1)

1967-1976: ```shell
#!/usr/bin/env bash

Verify no lingering usages of the old key in code, tests, or docs

rg -n function_call_result || true
rg -n functionCallResult || true
rg -n '"function_call_result"' || true
rg -n '"functionCallResult"' || true


</details>
<details>
<summary>src/main/presenter/llmProviderPresenter/index.ts (3)</summary>

`701-706`: **Terminology updated to `function_call_record`**  
The comment and `formattedToolRecordText` variable correctly reflect the new semantic scope for non-native function calls by embedding a `function_call_record`.

---

`713-726`: **Safe append to existing assistant message**  
The branching logic covers all cases—string, array, or undefined—when adding the formatted tool record, preventing runtime type errors.

---

`728-734`: **Fallback creation of standalone assistant message**  
When no prior assistant message exists, you correctly push a new one containing the record as an array of text parts.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@zerob13 zerob13 merged commit fa8a91a into ThinkInAIXYZ:dev Jun 17, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants