veadk-python 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

veadk/utils/mcp_utils.py

@@ -0,0 +1,44 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Any
+
+from google.adk.tools.mcp_tool.mcp_toolset import (
+    SseConnectionParams,
+    StreamableHTTPConnectionParams,
+)
+
+from veadk.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def get_mcp_params(url: str) -> Any:
+    """Automatically set MCP connection params according to url.
+
+    Only support http and sse protocol.
+
+    Args:
+        url (str): MCP server url
+    """
+    if "/mcp" in url:
+        logger.info("MCP url detected, use StreamableHTTPConnectionParams.")
+        return StreamableHTTPConnectionParams(url=url)
+    elif "/sse" in url:
+        logger.info("SSE url detected, use SseConnectionParams.")
+        return SseConnectionParams(url=url)
+    else:
+        raise ValueError(
+            "Unsupported MCP url, because it has no `/mcp` or `/sse` field in your url. Please specify your connection params manually."
+        )

veadk/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-VERSION = "0.1.0"
+VERSION = "0.2.0"

{veadk_python-0.1.0.dist-info → veadk_python-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.1.0
+Version: 0.2.0
 Summary: Volcengine agent development kit, integrations with Volcengine cloud services.
 Author-email: Yaozheng Fang <fangyozheng@gmail.com>, Guodong Li <cu.eric.lee@gmail.com>, Zhi Han <sliverydayday@gmail.com>, Meng Wang <mengwangwm@gmail.com>
 Requires-Python: >=3.10
@@ -79,9 +79,18 @@ uv pip install -e .
 
 ## Configuration
 
-We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically.
+We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
 
-You can refer to the [example config file](config.yaml.example) for more details.
+```yaml
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: # <-- set your Volcengine ARK api key here
+```
+
+You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
 
 ## Have a try
 
@@ -101,8 +110,8 @@ print(res)
 
 VeADK provides several useful command line tools for faster deployment and optimization, such as:
 
-- `veadk deploy`: deploy your project to Volcengine VeFaaS platform (you can use `veadk init` to init a demo project first)
-- `veadk prompt`: otpimize the system prompt of your agent by PromptPilot
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
 
 ## Contribution