关于 integration-create
integration-create 是用于起草 adk-docs 集成页面的技能,面向 ADK 文档贡献者。它指导收集需求、参照现有类别示例,并准备草稿以供审查和渲染检查。
主要功能
- 01收集集成信息与需求
- 02选择文件名和页面类别
- 03提供三类页面模板
- 04指导后续审查与渲染检查
适用场景
- 01起草 MCP 工具集成页面
- 02创建可观测性或插件页面
- 03准备草稿并使用 integration-review 审查
MCP 相关
对于 MCP 工具页面,该技能涵盖 MCP 服务文档,并要求收集连接方式和公开的工具信息。
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ google/ adk-docs --skill integration-create安装后在 Claude Code 中输入/integration-create确认已加载。
附带文件README.md
详细介绍
ADK 集成页面创建器(integration-create)
此技能用于为 adk-docs 仓库创建新的集成页面。集成页面位于 docs/integrations/ 下,并会自动发现并加入卡片目录。此技能的输出是良好的起点,而非完成的页面:完成后,请对页面运行 integration-review 技能,并使用 mkdocs serve 进行测试。
真正的模板是现有的已发布页面。起草前,请打开所选类别的示例页面,并遵循其结构和惯例:
- MCP 工具:
docs/integrations/github.md、docs/integrations/notion.md - 可观测性:
docs/integrations/phoenix.md、docs/integrations/arize-ax.md - 插件:
docs/integrations/daytona.md、docs/integrations/goodmem.md
若要查找更多相似页面,可一次性扫描 catalog_tags(grep catalog_tags docs/integrations/*.md),并完整阅读具有该类别标签(例如
mcp、observability)或产品领域标签的页面。应遵循现有页面和仓库惯例,而非仅根据下方模板进行推断。
面向用户的要求请参阅 CONTRIBUTING.md 中的 “Integrations” 部分。审核时适用的完整规则请参阅 integration-review 技能。
步骤 1:收集信息
询问用户补充尚未提供的信息:
- 产品 / 集成名称(用于确定
catalog_title和 H1)。 - 类别,用于选择模板:
- MCP 工具(Agent 连接的 MCP 服务)
- 可观测性(追踪 / 指标 / 评估导出器)
- 插件(提供工具或回调的可安装软件包)
- 语言支持:仅 Python,还是 Python + TypeScript。
- 软件包名称(PyPI / npm)和安装命令。
- MCP 连接方式:本地(stdio)和/或远程(HTTP)。
- 集成公开的工具或方法(用于表格)。
- 链接:产品文档、GitHub 仓库、PyPI/npm、API 密钥获取方式。
- 图标:确认将在
docs/integrations/assets/<slug>.png添加资源文件。
步骤 2:选择文件名
- 使用基于产品或技术名称的简短、小写、以连字符分隔的 slug。
- 避免使用
adk-或其他会使卡片在按字母排序的目录中排到前面的前缀。 - 在
docs/integrations/<slug>.md创建文件。
步骤 3:起草页面
使用下方的 frontmatter 和类别框架。阅读同一类别的示例页面,并据此调整文案和代码,填写每个部分。
不要添加 mkdocs.yml 导航项;页面会通过 render_catalog('integrations/*.md') 自动发现。仅当此页面取代现有 URL 时才添加重定向,并且切勿串联重定向。
步骤 4:交接
告知用户这只是草稿,然后:
- 提醒他们在
docs/integrations/assets/<slug>.png添加图标资源文件(正方形、尺寸适中),以及任何截图。 - 建议对新页面运行
integration-review技能。 - 建议运行
mkdocs serve,确认卡片能够正常显示且图标已加载。
Frontmatter(所有类别)
---
catalog_title: <Display Name>
catalog_description: <short verb-led phrase>
catalog_icon: /integrations/assets/<slug>.png
catalog_tags: ["<tag>", "<tag>"]
---
catalog_description:简短、以动词开头,约 45 到 75 个字符(约 6 到 11 个词);长度应低于约 80 个字符,避免在卡片上出现不自然的换行。不要重复产品名称(标题中会显示)。避免冗长列表和夸大描述。catalog_tags:仅使用目录中已有的标签;切勿自行创建标签。使用grep catalog_tags docs/integrations/*.md一次性列出有效标签。标签可以组合使用。任何使用 MCP 的页面都必须包含mcp。catalog_icon:/integrations/assets/<slug>.png(或.svg或.jpg)。不要添加/adk-docs/前缀。
H1 和语言支持标签(所有类别)
# <Product> <type> for ADK
<type> 根据类别填写 MCP tool、observability 或 plugin。紧接 H1 后添加语言支持 div(所有 span 必须写在同一行;仅支持 Python 时,删除 TypeScript span):
<div class="language-support-tag">
<span class="lst-supported">Supported in ADK</span><span class="lst-python">Python</span><span class="lst-typescript">TypeScript</span>
</div>
骨架:MCP 工具
## Use cases
- **<Use case>**: <what the user accomplishes>
- **<Use case>**: <...>
## Prerequisites
- <account, API key, or token, with a link to where to get it>
## Use with agent
=== "Python"
=== "Remote MCP Server"
```python
from google.adk.agents import Agent
from google.adk.tools.mcp_tool import McpToolset
from google.adk.tools.mcp_tool.mcp_session_manager import StreamableHTTPConnectionParams
root_agent = Agent(
model="gemini-flash-latest",
name="<slug>_agent",
instruction="Help users get information from <Product>",
tools=[
McpToolset(
connection_params=StreamableHTTPConnectionParams(
url="<server url>",
headers={"Authorization": "Bearer YOUR_TOKEN"},
),
)
],
)
```
=== "TypeScript"
=== "Remote MCP Server"
```typescript
import { LlmAgent, MCPToolset } from "@google/adk";
const rootAgent = new LlmAgent({
model: "gemini-flash-latest",
name: "<slug>_agent",
instruction: "Help users get information from <Product>",
tools: [
new MCPToolset({
type: "StreamableHTTPConnectionParams",
url: "<server url>",
}),
],
});
export { rootAgent };
```
## Available tools
Tool | Description
---- | -----------
`<tool>` | <what it does>
## Additional resources
- [<Product> Documentation](<url>)
- [<Product> Repository](<url>)
如果服务同时支持这两种方式,请添加 Local MCP Server(stdio)和 Remote MCP Server 子标签页。添加 ## Configuration 部分,说明可选的请求头或环境变量。
骨架:可观测性
<one-paragraph intro of what the platform provides for ADK>
## Overview
- **<Capability>**: <...>
- **<Capability>**: <...>
## Installation
```bash
pip install <package>
```
## Setup
<API keys, environment variables, and instrumentor initialization>
## Observe
<a complete, runnable ADK agent example that is traced end-to-end>
## Support and Resources
- [<Platform> Documentation](<url>)
- [<Platform> Repository](<url>)
使用单个可复制粘贴的端到端代码块也可以,而且通常比拆分为 Setup 和 Observe 更好。
骨架:插件
## Use cases
- **<Use case>**: <...>
## Prerequisites
- <account / API key with link>
## Installation
```bash
pip install <package>
```
## Use with agent
```python
from <package> import <Plugin>
from google.adk.agents import Agent
root_agent = Agent(
model="gemini-flash-latest",
name="<slug>_agent",
instruction="<what the agent does>",
tools=<plugin>.get_tools(),
)
```
## Available tools
Tool | Description
---- | -----------
`<tool>` | <what it does>
## Additional resources
- [<Product> Documentation](<url>)
- [<Product> on PyPI](<url>)
- [<Product> on GitHub](<url>)
如适用,请添加 ## Configuration 部分,说明环境变量。
需要遵循的风格规则
- 示例代码中的模型字符串应使用
gemini-flash-latest、gemini-pro-latest或其他有效的*-latest别名,而不要使用特定版本的模型字符串,因为新模型版本发布后,后者会增加维护负担。 - 导入语句:
from google.adk.agents import Agent;MCP 使用from google.adk.tools.mcp_tool import McpToolset。Agent 变量名为 Python 中的root_agent/ TypeScript 中的rootAgent(并使用export { rootAgent };)。 - 不要使用长破折号,也不要写冗长的 AI 生成内容:在
**术语**:定义列表中使用冒号;其他情况下将文字拆分为多个句子。 - 提及 ADK 时,使用“ADK”,绝不要使用“Google ADK”或“The ADK”。
- 不要以行内代码词语开头写句子。
- ADK 文档内部链接应使用站点相对路径(例如
/sessions/memory/);外部链接必须可访问。不要编造链接。 - 根据实际 API 和库代码验证所有代码示例。规范源代码仓库列于
docs/community/contributing-guide.md。 - 提交草稿前,请确认该软件包已发布到 PyPI/npm。