Skip to content

Provides Gemini with up-to-date information about ADK. The documentation content is sourced from llms.txt - either from the official ADK-Docs repo, or one you supply.

Notifications You must be signed in to change notification settings

derailed-dash/adk-docs-ext

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ADK Docs Extension for Gemini CLI

This extension provides documentation support for using the Agent Development Kit (ADK).

Repo Metadata

Author: Darren Lester

How It Works

This Gemini CLI extension uses the MCP LLMS-TXT Doc Server to provide the Gemini model with up-to-date information about ADK. The documentation content is sourced from the llms.txt file in the official ADK-Docs. This file is effectively a sitemap of the ADK documentation.

The extension's GEMINI.md file provides instructions to the Gemini model, guiding it to use the tools provided by this extension when answering questions about ADK.

Why Is This Useful?

This extension empowers Gemini CLI to provide accurate and current information about ADK, without relying on potentially outdated internal knowledge. This is particularly useful for:

  • Answering questions about ADK's features and APIs.
  • Assisting with development tasks related to ADK.
  • Ensuring that the information provided by the Gemini CLI is consistent with the latest ADK documentation.

Extension Installation into Gemini CLI

The easiest way to install this extension is with this command:

gemini extensions install https://github.com/derailed-dash/adk-docs-ext

The command will respond with:

Extension "adk-docs-ext" installed successfully and enabled.

Alternatively, you can clone this repo directly into your extensions folder.

For global installation:

mkdir -p ~/.gemini/extensions
git clone https://github.com/derailed-dash/adk-docs-ext.git ~/.gemini/extensions/adk-docs-ext

For workspace-level installation:

mkdir -p ./.gemini/extensions
git clone https://github.com/derailed-dash/adk-docs-ext.git ./.gemini/extensions/adk-docs-ext

Gemini CLI will automatically load the extension on startup and will then use the relevant tools to answer any questions relating to ADK.

Using an Alternative llms.txt Path

You may prefer to specify an alternate location for your llms.txt, such as a local copy of the file that you generate using a custom tool.

To use it, amend the gemini-extension.json and replace this:

    "--urls",
    "https://google.github.io/adk-docs/llms.txt",

with this:

    "--urls",
    "Local_ADK_Docs:/path/to/local/llms.txt",

E.g. if you're using the provided sample:

{
  "name": "adk-docs-ext",
  "version": "1.0.2",
  "mcpServers": {
    "adk-docs-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "mcpdoc",
        "mcpdoc",
        "--urls",
        "Local_ADK_Docs:${extensionPath}/sample_llms_txt/local_adk_docs_llms.txt",
        "--allowed-domains",
        "*",
        "--transport",
        "stdio"
      ]
    }
  },
  "contextFileName": "GEMINI.md"
}

Acknowledgements

This extension was inspired by the gemini-docs-ext by Mark McDonald.

About

Provides Gemini with up-to-date information about ADK. The documentation content is sourced from llms.txt - either from the official ADK-Docs repo, or one you supply.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published