Atlan 代理工具包

此仓库包含一系列用于 AI 代理与 Atlan 服务交互的工具和协议。每个组件都设计为提供特定功能，可独立使用或组合使用。

组件

模型上下文协议 (MCP)

一个通过函数调用与 Atlan 服务交互的协议服务器。提供使用 pyatlan 进行资产搜索和检索的工具。

贡献指南

我们欢迎对 Atlan 代理工具包的贡献！请在提交拉取请求时遵循以下指南：

1. 创建新分支：

   • 为您的更改创建一个新分支。
   • 使用描述性名称命名分支（例如，feature/add-new-tool）。

2. 进行更改：

   • 在新分支中进行更改。
   • 确保您的工具定义清晰并遵循 MCP 规范。

3. 提交拉取请求：

   • 将更改推送到您的分支。
   • 针对 main 分支创建一个拉取请求。
   • 提供更改的清晰描述以及任何相关问题。
   • 确保拉取请求通过所有 CI 检查后再请求审查。

4. 代码质量：

   • 我们使用 pre-commit 钩子来维护代码质量。
   • 在本地环境中安装 pre-commit：
     bash 复制代码

     uv pip install pre-commit
     pre-commit install

   • pre-commit 将在每次提交前自动运行检查，包括：
     • 使用 Ruff 进行代码格式化
     • 删除尾随空白
     • 修复文件末尾
     • YAML 和 JSON 验证
     • 其他质量检查

5. 环境设置：

   • 本项目使用 UV 进行依赖管理。
   • 请参阅 模型上下文协议 README 获取设置说明。
   • 需要 Python 3.11 或更高版本。

6. 文档：

   • 更新文档以反映您的更改。
   • 在必要时为代码添加注释。