Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neuroa.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Tool calling allows models to call external functions or APIs, enabling dynamic, structured workflows inside chat interactions.

​
⚙️ How It Works

  1. Define Tools — Provide a list of available tools with names, descriptions, and parameters.
  2. Start Chat — Send user messages as usual.
  3. Receive Tool Call — The model may decide to call a tool based on context.
  4. Execute Tool — Your backend runs the function and returns the result.
  5. Continue Chat — Pass the result back into the conversation for further interaction.

​
🗂️ Tool Definition Example

{
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "getWeather",
        "description": "Get the current weather for a city.",
        "parameters": {
          "type": "object",
          "properties": {
            "location": {
              "type": "string",
              "description": "City and country, e.g., 'Paris, France'"
            }
          },
          "required": ["location"]
        }
      }
    }
  ]
}
📤 Request Example 
{
  "model": "openai/gpt-4o",
  "messages": [
    { "role": "user", "content": "What's the weather in Tokyo?" }
  ],
  "tools": [ ... ],
  "tool_choice": "auto"
}
Field Type Required Description tools object[] ✅ Array of tool definitions tool_choice string ✅ “auto” lets the model decide when to invoke tools 📨 Tool Call Response Example 
{
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "call-abc",
            "type": "function",
            "function": {
              "name": "getWeather",
              "arguments": "{\"location\":\"Tokyo, Japan\"}"
            }
          }
        ]
      }
    }
  ]
}
📌 Note: You need to parse arguments and execute the function. 🔁 Returning Tool Result 
{
  "role": "tool",
  "tool_call_id": "call-abc",
  "content": "{\"temperature\":\"28°C\",\"condition\":\"Sunny\"}"
}
The model will continue responding based on the tool’s output. ✅ Best Practices • Define clear descriptions for tools to guide the model. • Use JSON Schema for input validation. • Handle errors gracefully and provide fallback messages if needed. • Log all tool calls for monitoring and debugging.