@devries-cameron20 / composio Mirror · read-only / commits / f170e237a
Fork 0

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 22, 22:00 UTC

docs: enhance custom provider creation documentation and scripts to support output directory option

balyan.sid@gmail.com committed Jul 2, 2025 at 14:13 UTC f170e237a16921d8b94eca2bdde66c0d83367930
3 files changed +81 -35
fern/pages/src/providers/py-custom.mdx
+7 -1
@@ -44,9 +44,15 @@ make create-provider name=myprovider
44
45 # Create an agentic provider
46 make create-provider name=myagent agentic=true
47 +
48 +# Create provider with custom output directory
49 +make create-provider name=myprovider output=/path/to/custom/dir
50 +
51 +# Combine options
52 +make create-provider name=myagent agentic=true output=/my/custom/path
53 ```
54
49 -This will create a new provider in `python/providers/<provider-name>/` with:
55 +This will create a new provider in the specified directory (default: `python/providers/<provider-name>/`) with:
56 - Complete package structure with `pyproject.toml`
57 - Provider implementation template
58 - Demo script
python/Makefile
+9 -6
@@ -15,14 +15,17 @@ provider:
15
16 create-provider:
17 @if [ -z "$(name)" ]; then\
18 - echo "Please provide a provider name: make create-provider name=<provider-name> [agentic=true]";\
18 + echo "Please provide a provider name: make create-provider name=<provider-name> [agentic=true] [output=<directory>]";\
19 exit 1;\
20 fi
21 - @if [ "$(agentic)" = "true" ]; then\
22 - python scripts/create_provider.py $(name) --agentic;\
23 - else\
24 - python scripts/create_provider.py $(name);\
25 - fi
21 + @ARGS="$(name)";\
22 + if [ "$(agentic)" = "true" ]; then\
23 + ARGS="$$ARGS --agentic";\
24 + fi;\
25 + if [ ! -z "$(output)" ]; then\
26 + ARGS="$$ARGS --output-dir $(output)";\
27 + fi;\
28 + bash scripts/create-provider.sh $$ARGS
29
30 env:
31 @echo "* creating new environment"
python/scripts/create-provider.sh
+65 -28
@@ -3,22 +3,41 @@
3 # Check if provider name is provided
4 if [ -z "$1" ]; then
5 echo "Please provide a provider name"
6 - echo "Usage: ./scripts/create-provider.sh <provider-name> [--agentic]"
6 + echo "Usage: ./scripts/create-provider.sh <provider-name> [--agentic] [--output-dir <directory>]"
7 exit 1
8 fi
9
10 PROVIDER_NAME=$1
11 -PROVIDER_PATH="python/providers/$PROVIDER_NAME"
11 +shift
12 +
13 +# Default output directory
14 +OUTPUT_DIR="python/providers"
15 +IS_AGENTIC=false
16 +
17 +# Parse optional arguments
18 +while [[ $# -gt 0 ]]; do
19 + case $1 in
20 + --agentic)
21 + IS_AGENTIC=true
22 + shift
23 + ;;
24 + --output-dir)
25 + OUTPUT_DIR="$2"
26 + shift 2
27 + ;;
28 + *)
29 + echo "Unknown option: $1"
30 + echo "Usage: ./scripts/create-provider.sh <provider-name> [--agentic] [--output-dir <directory>]"
31 + exit 1
32 + ;;
33 + esac
34 +done
35 +
36 +PROVIDER_PATH="$OUTPUT_DIR/$PROVIDER_NAME"
37 # Convert to title case (e.g., myai -> Myai)
38 CAPITAL_PROVIDER_NAME="$(tr '[:lower:]' '[:upper:]' <<< ${PROVIDER_NAME:0:1})${PROVIDER_NAME:1}"
39 PACKAGE_NAME="composio_$PROVIDER_NAME"
40
16 -# Check if provider should be agentic
17 -IS_AGENTIC=false
18 -if [ "$2" = "--agentic" ]; then
19 - IS_AGENTIC=true
20 -fi
21 -
41 # Check if provider directory already exists
42 if [ -d "$PROVIDER_PATH" ]; then
43 echo "❌ Provider '$PROVIDER_NAME' already exists in $PROVIDER_PATH"
@@ -73,7 +92,7 @@ setup(
92 classifiers=[
93 "Development Status :: 3 - Alpha",
94 "Intended Audience :: Developers",
76 - "License :: OSI Approved :: MIT License",
95 + "License :: OSI Approved :: Apache Software License",
96 "Programming Language :: Python :: 3",
97 "Programming Language :: Python :: 3.10",
98 "Programming Language :: Python :: 3.11",
@@ -100,15 +119,19 @@ cat > "$PROVIDER_PATH/$PACKAGE_NAME/provider.py" << EOL
119 ${CAPITAL_PROVIDER_NAME} Provider implementation.
120 """
121
103 -from typing import Any, Callable, Dict, List, Sequence
104 -from composio.core.provider import AgenticProvider, AgenticProviderExecuteFn
122 +from __future__ import annotations
123 +
124 +import typing as t
125 +
126 +from composio.core.provider import AgenticProvider
127 +from composio.core.provider.agentic import AgenticProviderExecuteFn
128 from composio.types import Tool
129
130
131 # Define your tool format
132 class ${CAPITAL_PROVIDER_NAME}Tool:
133 """${CAPITAL_PROVIDER_NAME} tool format"""
111 - def __init__(self, name: str, description: str, execute: Callable, schema: dict):
134 + def __init__(self, name: str, description: str, execute: t.Callable, schema: dict):
135 self.name = name
136 self.description = description
137 self.execute = execute
@@ -116,7 +139,7 @@ class ${CAPITAL_PROVIDER_NAME}Tool:
139
140
141 class ${CAPITAL_PROVIDER_NAME}Provider(
119 - AgenticProvider[${CAPITAL_PROVIDER_NAME}Tool, List[${CAPITAL_PROVIDER_NAME}Tool]],
142 + AgenticProvider[${CAPITAL_PROVIDER_NAME}Tool, t.List[${CAPITAL_PROVIDER_NAME}Tool]],
143 name="${PROVIDER_NAME}"
144 ):
145 """
@@ -129,7 +152,7 @@ class ${CAPITAL_PROVIDER_NAME}Provider(
152 execute_tool: AgenticProviderExecuteFn
153 ) -> ${CAPITAL_PROVIDER_NAME}Tool:
154 """Wrap a tool in the ${PROVIDER_NAME} format."""
132 - def execute_wrapper(**kwargs) -> Dict:
155 + def execute_wrapper(**kwargs) -> t.Dict:
156 result = execute_tool(tool.slug, kwargs)
157 if not result.get("successful", False):
158 raise Exception(result.get("error", "Tool execution failed"))
@@ -144,9 +167,9 @@ class ${CAPITAL_PROVIDER_NAME}Provider(
167
168 def wrap_tools(
169 self,
147 - tools: Sequence[Tool],
170 + tools: t.Sequence[Tool],
171 execute_tool: AgenticProviderExecuteFn
149 - ) -> List[${CAPITAL_PROVIDER_NAME}Tool]:
172 + ) -> t.List[${CAPITAL_PROVIDER_NAME}Tool]:
173 """
174 Get composio tools wrapped as a list of ${CAPITAL_PROVIDER_NAME} tools.
175 """
@@ -158,7 +181,10 @@ cat > "$PROVIDER_PATH/$PACKAGE_NAME/provider.py" << EOL
181 ${CAPITAL_PROVIDER_NAME} Provider implementation.
182 """
183
161 -from typing import List, Optional, Sequence, TypeAlias, Dict
184 +from __future__ import annotations
185 +
186 +import typing as t
187 +
188 from composio.core.provider import NonAgenticProvider
189 from composio.types import Tool, Modifiers, ToolExecutionResponse
190
@@ -173,7 +199,7 @@ class ${CAPITAL_PROVIDER_NAME}Tool:
199
200
201 # Define your tool collection format
176 -${CAPITAL_PROVIDER_NAME}ToolCollection: TypeAlias = List[${CAPITAL_PROVIDER_NAME}Tool]
202 +${CAPITAL_PROVIDER_NAME}ToolCollection: t.TypeAlias = t.List[${CAPITAL_PROVIDER_NAME}Tool]
203
204
205 class ${CAPITAL_PROVIDER_NAME}Provider(
@@ -196,7 +222,7 @@ class ${CAPITAL_PROVIDER_NAME}Provider(
222 }
223 )
224
199 - def wrap_tools(self, tools: Sequence[Tool]) -> ${CAPITAL_PROVIDER_NAME}ToolCollection:
225 + def wrap_tools(self, tools: t.Sequence[Tool]) -> ${CAPITAL_PROVIDER_NAME}ToolCollection:
226 """Transform a collection of tools"""
227 return [self.wrap_tool(tool) for tool in tools]
228
@@ -204,7 +230,7 @@ class ${CAPITAL_PROVIDER_NAME}Provider(
230 self,
231 user_id: str,
232 tool_call: dict,
207 - modifiers: Optional[Modifiers] = None
233 + modifiers: t.Optional[Modifiers] = None
234 ) -> ToolExecutionResponse:
235 """
236 Execute a tool call.
@@ -224,9 +250,9 @@ class ${CAPITAL_PROVIDER_NAME}Provider(
250 def handle_tool_calls(
251 self,
252 user_id: str,
227 - response: Dict,
228 - modifiers: Optional[Modifiers] = None
229 - ) -> List[ToolExecutionResponse]:
253 + response: t.Union[dict, t.Any],
254 + modifiers: t.Optional[Modifiers] = None
255 + ) -> t.List[ToolExecutionResponse]:
256 """
257 Handle tool calls from ${CAPITAL_PROVIDER_NAME} response.
258
@@ -236,6 +262,17 @@ class ${CAPITAL_PROVIDER_NAME}Provider(
262 :return: A list of output objects from the tool calls.
263 """
264 # TODO: Implement based on ${CAPITAL_PROVIDER_NAME}'s response format
265 + # Example:
266 + # outputs = []
267 + # for tool_call in response.tool_calls:
268 + # outputs.append(
269 + # self.execute_tool_call(
270 + # user_id=user_id,
271 + # tool_call=tool_call,
272 + # modifiers=modifiers,
273 + # )
274 + # )
275 + # return outputs
276 raise NotImplementedError("Tool call handling not implemented yet")
277 EOL
278 fi
@@ -253,7 +290,7 @@ ${CAPITAL_PROVIDER_NAME} demo.
290 import asyncio
291
292 # from ${PROVIDER_NAME}_framework import Agent, Runner # Import your agent framework
256 -from $PACKAGE_NAME import ${CAPITAL_PROVIDER_NAME}Provider
293 +from composio_${PROVIDER_NAME} import ${CAPITAL_PROVIDER_NAME}Provider
294
295 from composio import Composio
296
@@ -300,7 +337,7 @@ cat > "$PROVIDER_PATH/${PROVIDER_NAME}_demo.py" << EOL
337 ${CAPITAL_PROVIDER_NAME} demo.
338 """
339
303 -from $PACKAGE_NAME import ${CAPITAL_PROVIDER_NAME}Provider
340 +from composio_${PROVIDER_NAME} import ${CAPITAL_PROVIDER_NAME}Provider
341 # from ${PROVIDER_NAME} import ${CAPITAL_PROVIDER_NAME} # Import your AI client
342
343 from composio import Composio
@@ -363,7 +400,7 @@ uv add $PACKAGE_NAME
400
401 \`\`\`python
402 from composio import Composio
366 -from $PACKAGE_NAME import ${CAPITAL_PROVIDER_NAME}Provider
403 +from composio_${PROVIDER_NAME} import ${CAPITAL_PROVIDER_NAME}Provider
404
405 # Initialize Composio with ${CAPITAL_PROVIDER_NAME} provider
406 composio = Composio(
@@ -387,7 +424,7 @@ tools = composio.tools.get(
424
425 \`\`\`python
426 from composio import Composio
390 -from $PACKAGE_NAME import ${CAPITAL_PROVIDER_NAME}Provider
427 +from composio_${PROVIDER_NAME} import ${CAPITAL_PROVIDER_NAME}Provider
428
429 # Initialize provider
430 provider = ${CAPITAL_PROVIDER_NAME}Provider()
@@ -472,7 +509,7 @@ We welcome contributions! Please see our [Contributing Guide](../../CONTRIBUTING
509
510 ## License
511
475 -ISC License
512 +Apache License 2.0
513
514 ## Support
515