Skip to content

ssl-oyamata/try-aws-gpt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenAI Agent × AWS公式ドキュメント検索 CLI アシスタント

このツールは、OpenAIのAgents SDKとAWS公式のドキュメント検索API(aws-documentation-mcp-server)を活用した、コマンドライン型のアシスタントです。AWSに関する質問を日本語で入力すると、公式ドキュメントから検索して回答してくれます。


🧰 主な機能

  • 🔍 AWS公式ドキュメントを検索(MCP API使用)
  • 🤖 GPT-4o による自然な日本語応答
  • 🛠️ function_tool によるツール連携

📁 ディレクトリ構成

.
├── main.py             # 起動スクリプト
└── tools
    └── aws_docs.py     # ドキュメント検索ツール

🚀 使い方

1. リポジトリをクローン

git clone https://github.com/ssl-oyamata/aws-docs-agent.git
cd aws-docs-agent

2. 必要なライブラリをインストール

pip install -r requirements.txt

必要な主なライブラリ:

  • openai
  • python-dotenv
  • loguru
  • openai-agents
  • aws-documentation-mcp-server

3. 環境変数を設定

.env ファイルを作成し、OpenAIのAPIキーを設定します。

OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxx

🧪 実行

python main.py

起動後、以下のように表示されます:

🔹 AWS Assistant 起動しました。質問をどうぞ(終了するには 'exit')

例:

🧑‍💻 あなた:S3のバケット名のルールを教えて
🤖 AWS Assistant(Agent)の回答:

[General purpose bucket naming rules - Amazon Simple Storage Service](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)

以下は一般的なバケット名のルールの要約です:

1. **長さ**: 3文字から63文字。
2. **文字**: 英小文字、数字、「.」および「-」を使用可能。
3. **開始と終了**: 数字または英小文字で始め、文字で終わらせる。
4. **形式**: IPアドレス形式を避ける。
5. **一意性**: バケット名はグローバルに一意である必要。

より詳細な情報を知りたい場合は、上記のドキュメントリンクを参照してください。

📝 ライセンス

このプロジェクトは MIT ライセンス のもとで公開されています。 ただし、外部ライブラリを利用しており、それぞれのライセンス条件に従う必要があります


🙏 参考資料

About

OpenAI Agents SDK を用いて AWS 公式ドキュメントを検索できる CLI

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages