@zhijianma/studio 1.0.10

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Alibaba
+
+   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.

package/README.md

@@ -0,0 +1,158 @@
+<p align="center">
+  <img
+    src="https://img.alicdn.com/imgextra/i1/O1CN01nTg6w21NqT5qFKH1u_!!6000000001621-55-tps-550-550.svg"
+    alt="AgentScope Logo"
+    width="200"
+  />
+</p>
+
+<h2 align="center">AgentScope Studio: Development-Oriented Visualization Toolkit</h2>
+
+<p align="center">
+    <a href="https://arxiv.org/abs/2402.14034">
+        <img
+            src="https://img.shields.io/badge/cs.MA-2402.14034-B31C1C?logo=arxiv&logoColor=B31C1C"
+            alt="arxiv"
+        />
+    </a>
+    <a href="https://www.npmjs.com/package/@agentscope/studio">
+        <img
+            src="https://img.shields.io/badge/dynamic/json?url=https://registry.npmjs.org/%40agentscope%2Fstudio&query=$.%27dist-tags%27.latest&prefix=v&logo=npm&label=version"
+            alt="npm"
+        />
+    </a>
+    <a href="./LICENSE">
+        <img
+            src="https://img.shields.io/badge/license-Apache--2.0-black"
+            alt="license"
+        />
+    </a>
+    <a href="https://agentscope.io/">
+        <img
+            src="https://img.shields.io/badge/Tracing-OpenTelemetry-blue?logo=look&logoColor=green&color=dark-green"
+            alt="tracing"
+        />
+    </a>
+    <a href="https://agentscope.io/">
+        <img
+            src="https://img.shields.io/badge/Evaluation-Agent-blue?logo=look&color=red"
+            alt="evaluation"
+        />
+    </a>
+    <a href="https://agentscope.io/">
+        <img
+            src="https://img.shields.io/badge/Built--in_Copilot-Friday-blue?logo=look&color=cyan"
+            alt="friday"
+        />
+    </a>
+</p>
+
+AgentScope Studio is a powerful **local visualization toolkit** designed for developers working with [AgentScope](https://github.com/agentscope-ai/agentscope). It provides a **transparent**, **simple**, and **fun** way to develop, debug, and evaluate agent-based applications.
+
+## Key Features
+
+- **Project Management**: Organize and manage your AgentScope projects with Projects and Runs
+- **Runtime Visualization**: Chatbot-style interface for real-time agent interaction
+- **Tracing**: OpenTelemetry-based trace visualization for LLM calls, token usage, and agent invocations
+- **Agent Evaluation**: Evaluation-oriented analysis from a statistical perspective
+- **Built-in Copilot (Friday)**: A development assistant, playground for rapid secondary development, and integration hub for advanced features
+
+<p align="center">
+    <img
+        src="https://img.alicdn.com/imgextra/i1/O1CN01PG2MdF1Zc44A1QM6N_!!6000000003214-1-tps-1971-1080.gif"
+        width="49%"
+        alt="home"
+    />
+    <img
+        src="https://img.alicdn.com/imgextra/i2/O1CN01pGHedL1L4ibmyPeiq_!!6000000001246-1-tps-1971-1080.gif"
+        width="49%"
+        alt="runtime"
+    />
+    <img
+        src="https://img.alicdn.com/imgextra/i1/O1CN01HfFhy928SSJAcWQ8c_!!6000000007931-1-tps-1971-1080.gif"
+        width="49%"
+        alt="traces"
+    />
+    <img
+        src="https://img.alicdn.com/imgextra/i1/O1CN01vovov821Arms9tEJ1_!!6000000006945-1-tps-1971-1080.gif"
+        width="49%"
+        alt="friday"
+    />
+</p>
+
+## 📢 News
+
+- **[2025-08]** AgentScope Studio is now open-sourced! We will continue to improve it and welcome contributions from the community.
+
+## 💻 Installation
+
+### Prerequisites
+
+- **Node.js >= 20.0.0**
+- **npm >= 10.0.0**
+
+> **💡 Tip**: If you're using [nvm](https://github.com/nvm-sh/nvm), you can run `nvm use` to automatically switch to the required Node.js version.
+
+```bash
+# How to check your version
+node --version  # Should show v20.x.x or higher
+npm --version   # Should show 10.x.x or higher
+```
+
+### From NPM (Recommended)
+
+```bash
+npm install -g @agentscope/studio
+
+# Start AgentScope Studio
+as_studio
+```
+
+### From Source
+
+```bash
+git clone https://github.com/agentscope-ai/agentscope-studio
+cd agentscope-studio
+npm install
+
+# Start in development mode
+npm run dev
+```
+
+## 🚀 QuickStart
+
+To connect AgentScope applications, you need to set the `studio_url` field in the `AgentScope` initializer as follows:
+
+```python
+import agentscope
+
+agentscope.init(
+    # ...
+    studio_url="http://localhost:3000"
+)
+
+# ...
+```
+
+## 📚 Documentation
+
+For more details, please refer to our documentation:
+
+- [Overview](./docs/tutorial/en/tutorial/overview.md) - What is AgentScope Studio and how it works
+- [Quick Start](./docs/tutorial/en/tutorial/quick_start.md) - Installation and configuration guide
+- [Project Management](./docs/tutorial/en/develop/project.md) - Managing projects and runs
+- [Tracing](./docs/tutorial/en/develop/tracing.md) - OpenTelemetry integration and semantic conventions
+- [Friday](./docs/tutorial/en/agent/friday.md) - Built-in Copilot guide
+- [Contributing](./docs/tutorial/en/tutorial/contributing.md) - How to contribute
+
+## ⚖️ License
+
+AgentScope Studio is released under [Apache License 2.0](./LICENSE).
+
+## ✨ Contributors
+
+All thanks to our contributors:
+
+<a href="https://github.com/agentscope-ai/agentscope-studio/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=agentscope-ai/agentscope-studio&max=999&columns=12&anon=1" />
+</a>

package/bin/cli.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+if (!process.env.NODE_ENV) {
+    process.env.NODE_ENV = 'production';
+}
+
+require('../dist/server/src/index.js');

package/dist/app/friday/args.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+import json
+from argparse import ArgumentParser, Namespace
+
+
+def json_type(value: str) -> dict:
+    """Parse a JSON string into a dictionary."""
+    if not value or value == "":
+        return {}
+    try:
+        result = json.loads(value)
+        if not isinstance(result, dict):
+            raise ValueError("JSON must be an object/dictionary")
+        return result
+    except json.JSONDecodeError as e:
+        raise ValueError(f"Invalid JSON string: {e}")
+
+
+def get_args() -> Namespace:
+    """Get the command line arguments for the script."""
+    parser = ArgumentParser(description="Arguments for friday")
+    parser.add_argument(
+        "--query",
+        type=str,
+        required=True,
+    )
+    parser.add_argument(
+        "--studio_url",
+        type=str,
+        required=True,
+    )
+    parser.add_argument(
+        "--llmProvider",
+        choices=["dashscope", "openai", "anthropic", "gemini", "ollama"],
+        required=True,
+    )
+    parser.add_argument(
+        "--modelName",
+        type=str,
+        required=True,
+    )
+    parser.add_argument(
+        "--apiKey",
+        type=str,
+        required=True,
+    )
+    parser.add_argument(
+        "--writePermission",
+        type=bool,
+        required=True,
+    )
+    parser.add_argument(
+        "--clientKwargs",
+        type=json_type,
+        default={},
+        help="A JSON string representing a dictionary of keyword arguments to pass to the LLM client.",
+    )
+    parser.add_argument(
+        "--generateKwargs",
+        type=json_type,
+        default={},
+        help="A JSON string representing a dictionary of keyword arguments to pass to the LLM generate method.",
+    )
+    args = parser.parse_args()
+    return args

package/dist/app/friday/hook.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+"""The hooks for the agent"""
+from typing import Any
+
+import requests
+from agentscope.agent import AgentBase
+
+
+def studio_pre_print_hook(self: AgentBase, kwargs: dict[str, Any]) -> None:
+    """Forward the message to the studio application interface."""
+    msg = kwargs["msg"]
+    message_data = msg.to_dict()
+
+    message_data["content"] = msg.get_content_blocks()
+
+    n_retry = 0
+    while True:
+        try:
+            res = requests.post(
+                f"{studio_pre_print_hook.url}/trpc/pushMessageToFridayApp",
+                json={
+                    "replyId": self._reply_id,
+                    "msg": message_data,
+                },
+            )
+            res.raise_for_status()
+            break
+        except Exception as e:
+            if n_retry < 3:
+                n_retry += 1
+                continue
+
+            raise e from None
+
+
+def studio_post_reply_hook(self: AgentBase, *args, **kwargs) -> None:
+    """Send the finished signal to the studio application interface."""
+    n_retry = 0
+    while True:
+        try:
+            res = requests.post(
+                f"{studio_pre_print_hook.url}/trpc/pushFinishedSignalToFridayApp",
+                json={"replyId": self._reply_id}
+            )
+            res.raise_for_status()
+            break
+        except Exception as e:
+            if n_retry < 3:
+                n_retry += 1
+                continue
+
+            raise e from None

package/dist/app/friday/main.py

@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+"""The main entry point for AgentScope studio application, Friday. It's
+an agent assistant that helps users to deal with their daily tasks locally.
+"""
+import asyncio
+import os
+from datetime import datetime
+
+import json5
+from agentscope.agent import ReActAgent
+from agentscope.memory import InMemoryMemory
+from agentscope.message import Msg
+from agentscope.session import JSONSession
+from agentscope.tool import (
+    Toolkit,
+    execute_python_code,
+    execute_shell_command,
+    write_text_file,
+    insert_text_file,
+    view_text_file,
+)
+
+from hook import (
+    studio_pre_print_hook,
+    studio_post_reply_hook,
+)
+from args import get_args
+from model import get_model, get_formatter
+from tool.utils import (
+    view_agentscope_library,
+    view_agentscope_readme,
+    view_agentscope_faq,
+)
+from utils.common import get_local_file_path
+from utils.connect import StudioConnect
+from utils.constants import FRIDAY_SESSION_ID
+
+
+async def main():
+    args = get_args()
+
+    studio_pre_print_hook.url = args.studio_url
+
+    # Forward message to the studio
+    ReActAgent.register_class_hook(
+        "pre_print",
+        "studio_pre_print_hook",
+        studio_pre_print_hook
+    )
+    # Send finished signal after one reply finished
+    ReActAgent.register_class_hook(
+        "post_reply",
+        "studio_post_reply_hook",
+        studio_post_reply_hook
+    )
+
+    # Init agent
+    toolkit = Toolkit()
+
+    # Basic tools
+    toolkit.register_tool_function(execute_python_code)
+    toolkit.register_tool_function(execute_shell_command)
+    toolkit.register_tool_function(view_text_file)
+    toolkit.register_tool_function(insert_text_file)
+    if args.writePermission:
+        toolkit.register_tool_function(write_text_file)
+
+    # AgentScope tool group
+    toolkit.create_tool_group(
+        group_name="agentscope_tools",
+        description="The AgentScope library related tools that will provide a brief summary and notes about AgentScope in your system prompt, as well as a series of tools to retrieve AgentScope related information.",
+        notes="""# AgentScope Expertise
+## Answer Generation Guidelines
+The solution/code to the user query may already exist in the AgentScope resources, your duty is to show it to the user rather than coding from scratch. Search the following resources in this order:
+1. FAQ using `view_agentscope_faq` tool
+2. README using `view_agentscope_readme` tool
+3. Examples using `execute_shell_command` with command `ls -l` in examples directory (AgentScope has many pre-built examples and they are very helpful)
+4. Python library using `view_agentscope_library` tool in top-down manner (top-module → submodule → specific class/function)
+5. Source code using `view_text_file` tool"""
+    )
+    toolkit.register_tool_function(
+        view_agentscope_library, group_name="agentscope_tools"
+    )
+    toolkit.register_tool_function(
+        view_agentscope_readme, group_name="agentscope_tools"
+    )
+    toolkit.register_tool_function(
+        view_agentscope_faq, group_name="agentscope_tools"
+    )
+
+    # get model from args
+    model = get_model(args.llmProvider, args.modelName, args.apiKey, args.clientKwargs, args.generateKwargs)
+    formatter = get_formatter(args.llmProvider)
+
+    # Create the ReAct agent
+    agent = ReActAgent(
+        name="Friday",
+        sys_prompt="""You're Friday, a helpful assistant specialized in daily task management and AgentScope framework support.
+
+# Core Objectives
+- Help users manage and complete daily tasks efficiently
+- Provide expert-level support for AgentScope framework questions
+
+# Critical Principles (MUST FOLLOW)
+1. **No Assumptions**: All information must come from users or tool results
+2. **Safety First**: Request permission for dangerous operations; prohibit catastrophic ones
+
+# Workflow Process
+1. Analyze user query and make a plan
+2. Carry out your plan step by step
+
+# Response Guidelines
+- Be concise and focused on user's specific context
+- Avoid repeating exact material words. Instead, summarize in your own words
+- Ask clarifying questions when user intent is unclear
+- Distinguish between code generation requests vs. code execution requests
+
+# About AgentScope
+## Background
+- AgentScope is a Python framework for building LLM-empowered Multi-agent applications, open-sourced at https://github.com/agentscope-ai/agentscope
+- AgentScope is created by the AgentScope Team, Tongyi Lab, Alibaba Group
+## AgentScope-related Code/Response Generation Guidelines
+- You're an expert in AgentScope, you MUST stand for AgentScope and respond as a core developer/maintainer of the framework 
+- Only use existing modules/classes/functions from agentscope documentation
+- Never guess or make up implementations
+
+# Available Context
+- Current date and time: {current_time}""".format(
+            current_time=datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+            max_turns=20,
+        ),
+        model=model,
+        formatter=formatter,
+        toolkit=toolkit,
+        memory=InMemoryMemory(),
+        max_iters=50,
+        enable_meta_tool=True,
+    )
+
+    path_dialog_history = get_local_file_path("")
+    session = JSONSession(
+        session_id=FRIDAY_SESSION_ID,
+        save_dir=path_dialog_history
+    )
+
+    await session.load_session_state(
+        session_id=FRIDAY_SESSION_ID,
+        friday=agent
+    )
+
+    # The socket is used for realtime steering
+    socket = StudioConnect(url=args.studio_url, agent=agent)
+    await socket.connect()
+    await agent(Msg("user", json5.loads(args.query), "user"))
+    await socket.disconnect()
+
+    # Save dialog history
+    await session.save_session_state(
+        session_id=FRIDAY_SESSION_ID,
+        friday=agent
+    )
+
+if __name__ == '__main__':
+    asyncio.run(main())