btw_tool_env_describe_environment

This tool can be used by the LLM to describe the contents of an R session,
i.e. the data frames and other objects loaded into the global environment.
This tool will only see variables that you've named and created in the
global environment, it cannot reach into package namespaces, see which
packages you have loaded, or access files on your computer.

A complete toolkit for connecting 'R' environments with Large
Language Models (LLMs). Provides utilities for describing 'R' objects,
package documentation, and workspace state in plain text formats
optimized for LLM consumption. Supports multiple workflows:
interactive copy-paste to external chat interfaces, programmatic tool
registration with 'ellmer' chat clients, batteries-included chat
applications via 'shinychat', and exposure to external coding agents
through the Model Context Protocol. Project configuration files enable
stable, repeatable conversations with project-specific context and
preferred LLM settings.

Garrick Aden-Buie

A Toolkit for Connecting R and Large Language Models

btw_tool_env_describe_environment function

<dl><dt>items</dt>
<dd>Optional. A character vector of objects in the environment to
describe.</dd>
<dt>_intent</dt>
<dd>An optional string describing the intent of the tool use.
When the tool is used by an LLM, the model will use this argument to
explain why it called the tool.</dd></dl>

Arguments

Tool: Describe an environment — btw_tool_env_describe_environment

<dl>

<dt>items</dt>
<dd>Optional. A character vector of objects in the environment to
describe.</dd>


<dt>_intent</dt>
<dd>An optional string describing the intent of the tool use.
When the tool is used by an LLM, the model will use this argument to
explain why it called the tool.</dd>

</dl>

btw_tool_env_describe_environment: Tool: Describe an environment

Description

Usage

Value

Arguments

See Also

Examples