Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 03:37 UTC
| 1 | """ |
| 2 | Tool Router preload with OpenAI Agents. |
| 3 | |
| 4 | Shows direct tool exposure for: |
| 5 | 1. Composio tools via preload["tools"]. |
| 6 | 2. SDK local tools via preload=True on the local tool or toolkit. |
| 7 | 3. A nested local tool override with preload=False inside a preloaded toolkit. |
| 8 | |
| 9 | Usage: |
| 10 | COMPOSIO_API_KEY=... OPENAI_API_KEY=... python examples/tool_router/preload.py |
| 11 | """ |
| 12 | |
| 13 | import os |
| 14 | |
| 15 | from agents import Agent, Runner |
| 16 | from composio_openai_agents import OpenAIAgentsProvider |
| 17 | from pydantic import BaseModel, Field |
| 18 | |
| 19 | from composio import Composio |
| 20 | |
| 21 | |
| 22 | def require_env(name: str) -> str: |
| 23 | value = os.environ.get(name) |
| 24 | if not value: |
| 25 | raise RuntimeError(f"Set {name} before running this example.") |
| 26 | return value |
| 27 | |
| 28 | |
| 29 | class UserLookupInput(BaseModel): |
| 30 | user_id: str = Field(description="Internal user ID, for example user-1") |
| 31 | |
| 32 | |
| 33 | class TeamSearchInput(BaseModel): |
| 34 | team: str = Field(description="Team name to search for") |
| 35 | |
| 36 | |
| 37 | class AccountInput(BaseModel): |
| 38 | user_id: str = Field(description="Internal user ID") |
| 39 | |
| 40 | |
| 41 | INTERNAL_USERS = { |
| 42 | "user-1": { |
| 43 | "id": "user-1", |
| 44 | "name": "Ada Lovelace", |
| 45 | "email": "ada@example.com", |
| 46 | "team": "platform", |
| 47 | "plan": "enterprise", |
| 48 | }, |
| 49 | "user-2": { |
| 50 | "id": "user-2", |
| 51 | "name": "Grace Hopper", |
| 52 | "email": "grace@example.com", |
| 53 | "team": "developer-tools", |
| 54 | "plan": "startup", |
| 55 | }, |
| 56 | } |
| 57 | |
| 58 | |
| 59 | composio = Composio( |
| 60 | api_key=require_env("COMPOSIO_API_KEY"), |
| 61 | provider=OpenAIAgentsProvider(), |
| 62 | ) |
| 63 | require_env("OPENAI_API_KEY") |
| 64 | |
| 65 | |
| 66 | @composio.experimental.tool( |
| 67 | slug="LOOKUP_INTERNAL_USER", |
| 68 | name="Lookup internal user", |
| 69 | description="Look up an internal demo user profile by user ID.", |
| 70 | preload=True, |
| 71 | ) |
| 72 | def lookup_internal_user(input: UserLookupInput, ctx): |
| 73 | user = INTERNAL_USERS.get(input.user_id) |
| 74 | if not user: |
| 75 | raise ValueError(f'User "{input.user_id}" not found') |
| 76 | return user |
| 77 | |
| 78 | |
| 79 | @composio.experimental.tool( |
| 80 | slug="SEARCH_INTERNAL_USERS", |
| 81 | name="Search internal users", |
| 82 | description=( |
| 83 | "Search demo internal users by team. This local tool is search-only " |
| 84 | "because preload is not enabled." |
| 85 | ), |
| 86 | ) |
| 87 | def search_internal_users(input: TeamSearchInput, ctx): |
| 88 | return { |
| 89 | "results": [ |
| 90 | user for user in INTERNAL_USERS.values() if user["team"] == input.team |
| 91 | ] |
| 92 | } |
| 93 | |
| 94 | |
| 95 | internal_admin = composio.experimental.Toolkit( |
| 96 | slug="INTERNAL_ADMIN", |
| 97 | name="Internal admin", |
| 98 | description="Demo internal administration tools.", |
| 99 | preload=True, |
| 100 | ) |
| 101 | |
| 102 | |
| 103 | @internal_admin.tool( |
| 104 | slug="GET_ACCOUNT_HEALTH", |
| 105 | name="Get account health", |
| 106 | description="Return internal account health details for a user.", |
| 107 | ) |
| 108 | def get_account_health(input: AccountInput, ctx): |
| 109 | return { |
| 110 | "user_id": input.user_id, |
| 111 | "health": "green", |
| 112 | "open_incidents": 0, |
| 113 | "renewal_risk": "low", |
| 114 | } |
| 115 | |
| 116 | |
| 117 | @internal_admin.tool( |
| 118 | slug="GET_ACCOUNT_AUDIT_LOG", |
| 119 | name="Get account audit log", |
| 120 | description=( |
| 121 | "Return internal account audit events. This overrides the toolkit " |
| 122 | "preload default and remains search-only." |
| 123 | ), |
| 124 | preload=False, |
| 125 | ) |
| 126 | def get_account_audit_log(input: AccountInput, ctx): |
| 127 | return { |
| 128 | "user_id": input.user_id, |
| 129 | "events": ["login", "settings_viewed"], |
| 130 | } |
| 131 | |
| 132 | |
| 133 | session = composio.create( |
| 134 | user_id="preload-example-user", |
| 135 | toolkits=["hackernews"], |
| 136 | tools={"hackernews": {"enable": ["HACKERNEWS_GET_USER"]}}, |
| 137 | preload={"tools": ["HACKERNEWS_GET_USER"]}, |
| 138 | manage_connections=False, |
| 139 | experimental={ |
| 140 | "local_tools": [lookup_internal_user, search_internal_users], |
| 141 | "local_toolkits": [internal_admin], |
| 142 | }, |
| 143 | ) |
| 144 | |
| 145 | tools = session.tools() |
| 146 | tool_names = [tool.name for tool in tools] |
| 147 | assert "HACKERNEWS_GET_USER" in tool_names |
| 148 | assert "LOCAL_LOOKUP_INTERNAL_USER" in tool_names |
| 149 | assert "LOCAL_INTERNAL_ADMIN_GET_ACCOUNT_HEALTH" in tool_names |
| 150 | assert "LOCAL_SEARCH_INTERNAL_USERS" not in tool_names |
| 151 | assert "LOCAL_INTERNAL_ADMIN_GET_ACCOUNT_AUDIT_LOG" not in tool_names |
| 152 | |
| 153 | print("Direct tools exposed to the agent:") |
| 154 | for tool in tools: |
| 155 | print(f"- {tool.name}") |
| 156 | |
| 157 | agent = Agent( |
| 158 | name="Preload Demo Agent", |
| 159 | instructions="Use the provided tools to perform the task.", |
| 160 | model=os.environ.get("OPENAI_MODEL", "gpt-5.5"), |
| 161 | tools=tools, |
| 162 | ) |
| 163 | |
| 164 | prompt = ( |
| 165 | 'Look up Hacker News user "pg", then look up internal user user-1 and ' |
| 166 | "their account health. Summarize the useful facts." |
| 167 | ) |
| 168 | result = Runner.run_sync(agent, prompt) |
| 169 | print(result.final_output) |