LLM 功能

本项目使您能够使用熟悉的语言（如 Bash、JavaScript 和 Python）轻松构建强大的 LLM 工具和智能体。

无需复杂的集成，利用 函数调用 的强大功能，将您的 LLM 直接连接到自定义代码，开启无限可能。执行系统命令、处理数据、与 API 交互——唯一的限制就是您的想象力。

工具展示

智能体展示

先决条件

请确保已安装以下工具：

• argc：一个 Bash 命令行框架和命令运行器
• jq：一个 JSON 处理器

使用 AIChat 入门

目前，AIChat 是唯一支持 llm-functions 的 CLI 工具。我们期待更多工具能够支持 llm-functions。

1. 克隆仓库

git clone https://github.com/sigoden/llm-functions
cd llm-functions

2. 构建工具和智能体

I. 创建一个 ./tools.txt 文件，每行写一个工具文件名。

get_current_weather.sh
execute_command.sh
#execute_py_code.py

web_search 工具在哪里？

web_search 工具本身并不存在，您可以从多种网络搜索工具中选择。

要将其用作 web_search 工具，请按照以下步骤操作：

1. 选择工具： 可用的工具包括：

   • web_search_cohere.sh
   • web_search_perplexity.sh
   • web_search_tavily.sh
   • web_search_vertexai.sh

2. 链接所选工具： 使用 argc 命令将您选择的工具链接为 web_search。例如，使用 web_search_perplexity.sh：

   $ argc link-web-search web_search_perplexity.sh
   

   此命令会创建一个符号链接，使 web_search.sh 指向您选择的 web_search_perplexity.sh 工具。

现在，web_search.sh 就可以添加到您的 ./tools.txt 中了。

II. 创建一个 ./agents.txt 文件，每行写一个智能体名称。

coder
todo

III. 构建 bin 和 functions.json

argc build

IV. 确保一切准备就绪（环境变量、Node/Python 依赖、mcp-bridge 服务器）

argc check

3. 链接 LLM-functions 和 AIChat

AIChat 期望 LLM-functions 放置在 AIChat 的 functions_dir 中，以便 AIChat 能够使用 LLM-functions 提供的工具和智能体。

您可以通过以下命令将此仓库目录软链接到 AIChat 的 functions_dir：

ln -s "$(pwd)" "$(aichat --info | sed -n 's/^functions_dir\s\+//p')"
# 或者
argc link-to-aichat

或者，您也可以通过设置环境变量来告诉 AIChat LLM-functions 目录的位置：

export AICHAT_FUNCTIONS_DIR="$(pwd)"

4. 开始使用这些功能

完成！现在您可以用 AIChat 使用这些工具和智能体。

aichat --role %functions% 巴黎的天气如何？
aichat --agent todo 列出我所有的待办事项

编写您自己的工具

为我们的平台构建工具非常简单。您可以利用现有的编程知识，因为工具本质上只是用您喜欢的语言编写的函数。

LLM Functions 会根据 注释 自动为工具生成 JSON 声明。请参考 ./tools/demo_tool.{sh,js,py}，了解如何使用注释来自动生成声明。

Bash

在 ./tools/ 目录下创建一个新的 Bash 脚本（例如 execute_command.sh）。

#!/usr/bin/env bash
set -e

# @describe 执行 Shell 命令。
# @option --command! 要执行的命令。

main() {
    eval "$argc_command" >> "$LLM_OUTPUT"
}

eval "$(argc --argc-eval "$0" "$@")"

Javascript

在 ./tools/ 目录下创建一个新的 JavaScript 文件（例如 execute_js_code.js）。

/**
 * 在 Node.js 中执行 JavaScript 代码。
 * @typedef {Object} Args
 * @property {string} code - 要执行的 JavaScript 代码，例如 `console.log("hello world")`
 * @param {Args} args
 */
exports.run = function ({ code }) {
  eval(code);
}

Python

在 ./tools/ 目录下创建一个新的 Python 脚本（例如 execute_py_code.py）。

def run(code: str):
    """执行 Python 代码。
    Args:
        code: 要执行的 Python 代码，例如 `print("hello world")`
    """
    exec(code)

编写您自己的智能体

智能体 = 提示词 + 工具（函数调用）+ 文档（RAG），这相当于 OpenAI 的 GPTs。

智能体的文件结构如下：

└── agents
    └── myagent
        ├── functions.json                  # 函数的 JSON 声明（自动生成）
        ├── index.yaml                      # 智能体定义
        ├── tools.txt                       # 共享工具
        └── tools.{sh,js,py}                # 智能体工具 

智能体定义文件 (index.yaml) 定义了您智能体的关键方面：

name: TestAgent                             
description: 这是一个测试智能体
version: 0.1.0
instructions: 你是一个用于...的测试 AI 智能体
conversation_starters:
  - 你能做什么？
variables:
  - name: foo
    description: 这是一个 foo
documents:
  - local-file.txt
  - local-dir/
  - https://example.com/remote-file.txt

有关如何实现智能体的示例，请参阅 ./agents/demo。

MCP（模型上下文协议）

• mcp/server：允许通过模型上下文协议使用 LLM-Functions 的工具/智能体。
• mcp/bridge：允许 LLM-Functions 使用外部 MCP 工具。

文档

• 工具指南
• 智能体指南
• Argc 命令

许可证

该项目采用 MIT 许可证。详细信息请参阅 LICENSE 文件。

llm-functions 快速上手指南

llm-functions 是一个让你能够使用熟悉的语言（Bash、JavaScript、Python）轻松构建强大 LLM 工具和智能体（Agent）的项目。它利用 Function Calling 技术，将大模型直接连接到你的自定义代码，实现执行系统命令、处理数据、调用 API 等功能。

目前，该项目主要配合 AIChat 命令行工具使用。

环境准备

在开始之前，请确保你的系统已安装以下依赖：

1. argc: 一个 Bash 命令行框架和命令运行器。
   • 安装方式参考：argc GitHub
2. jq: 一个强大的 JSON 处理器。
   • Ubuntu/Debian: sudo apt install jq
   • macOS: brew install jq
   • CentOS/RHEL: sudo yum install jq
3. AIChat: 支持 llm-functions 的 CLI 客户端。
   • 安装方式参考：AIChat GitHub
4. 运行时环境 (按需):
   • 若编写 JS 工具，需安装 Node.js。
   • 若编写 Python 工具，需安装 Python 及相关依赖。

安装步骤

1. 克隆项目

git clone https://github.com/sigoden/llm-functions
cd llm-functions

2. 配置工具与智能体

第一步：创建工具列表

在项目根目录创建 tools.txt 文件，每行写入一个你想启用的工具脚本文件名（位于 ./tools/ 目录下）。

get_current_weather.sh
execute_command.sh
#execute_py_code.py

关于 Web 搜索工具： 项目中没有默认的 web_search.sh。你需要从现有的搜索工具中选择一个并建立链接。 可选工具：web_search_cohere.sh, web_search_perplexity.sh, web_search_tavily.sh, web_search_vertexai.sh。

例如，链接 Perplexity 作为默认搜索工具：

argc link-web-search web_search_perplexity.sh

执行后，将 web_search.sh 添加到你的 tools.txt 中。

第二步：创建智能体列表

在项目根目录创建 agents.txt 文件，每行写入一个你想启用的智能体名称（位于 ./agents/ 目录下）。

coder
todo

第三步：构建项目

运行以下命令生成 bin 目录和 functions.json 声明文件：

argc build

第四步：环境检查

运行检查命令，确保环境变量、依赖包及 MCP 桥接服务就绪：

argc check

3. 关联 AIChat

AIChat 需要知道 llm-functions 的位置才能加载工具和智能体。你可以选择以下任一方式：

方式 A：创建软链接（推荐） 将当前目录链接到 AIChat 的默认函数目录：

ln -s "$(pwd)" "$(aichat --info | sed -n 's/^functions_dir\s\+//p')"
# 或者使用封装好的命令
argc link-to-aichat

方式 B：设置环境变量 临时或永久导出环境变量指定目录：

export AICHAT_FUNCTIONS_DIR="$(pwd)"

基本使用

配置完成后，即可通过 aichat 命令调用工具或智能体。

调用工具示例（查询天气）：

aichat --role %functions% what is the weather in Paris?

调用智能体示例（管理待办事项）：

aichat --agent todo list all my todos

---

进阶：编写自定义工具

你只需在 ./tools/ 目录下创建脚本，并通过注释定义参数，系统会自动生成 JSON 声明。

Bash 示例 (execute_command.sh):

#!/usr/bin/env bash
set -e

# @describe Execute the shell command.
# @option --command! The command to execute.

main() {
    eval "$argc_command" >> "$LLM_OUTPUT"
}

eval "$(argc --argc-eval "$0" "$@")"

JavaScript 示例 (execute_js_code.js):

/**
 * Execute the javascript code in node.js.
 * @typedef {Object} Args
 * @property {string} code - Javascript code to execute, such as `console.log("hello world")`
 * @param {Args} args
 */
exports.run = function ({ code }) {
  eval(code);
}

Python 示例 (execute_py_code.py):

def run(code: str):
    """Execute the python code.
    Args:
        code: Python code to execute, such as `print("hello world")`
    """
    exec(code)

进阶：编写自定义智能体

智能体由提示词、工具集和文档（RAG）组成。在 ./agents/ 下创建文件夹，包含 index.yaml 定义文件即可。

index.yaml 结构示例:

name: TestAgent                             
description: This is test agent
version: 0.1.0
instructions: You are a test ai agent to ... 
conversation_starters:
  - What can you do?
variables:
  - name: foo
    description: This is a foo
documents:
  - local-file.txt
  - https://example.com/remote-file.txt