代理工具Monorepo
该存储库是一组旨在供AI代理使用的工具和服务。它是开发、记录和管理各种工具的中心枢纽,从简单的可调用Python函数到更复杂的容器化MCP(多代理通信协议)服务器。
指导原则
- 模块化: 每个工具都应该包含在自己的子目录中。
- 可发现性: 人类和代理都应该很容易找到可用的工具以及如何使用它们。
- 一致性: 工具应遵循一致的结构和文档格式。
目录结构
我们建议使用以下目录结构来组织存储库:
/
├── tools/
│ ├── tool_one/
│ │ ├── Dockerfile # Optional: If it's a containerized service
│ │ ├── main.py # Main entrypoint for the tool
│ │ ├── pyproject.toml # Or requirements.txt, for dependencies
│ │ └── README.md # Human-readable documentation for the tool
│ └── tool_two/
│ ├── ...
├── docs/ # For overall project documentation
├── .gitignore
├── AGENTS.md # Instructions specifically for AI agents
└── README.md # This file入门指南
- 克隆存储库:
git clone
cd - 探索可用的工具:
每个工具都位于其自己的目录中 tools/。请参阅 README.md 在每个工具的目录中,提供有关安装、配置和使用的具体说明。
添加新工具
- 在下创建新的子目录
tools/. - 添加您的工具代码和
pyproject.toml管理与uv. - 至关重要的是,创建一个
tool-spec.json或openapi.json这清楚地定义了工具的界面。 - 添加a
README.md用于人类可读的上下文。 - 确保所有代码都通过
ruff检查。
贡献指南
- 分叉存储库。
- 为您的功能创建新分支(
git checkout -b feature/my-new-tool). - 提交您的更改(
git commit -am 'Add some tool'). - 推到分支(
git push origin feature/my-new-tool). - 创建新的Pull Request。
