Skip to content

docs: fix import paths for Workflow and WorkflowResult #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2025
Merged

docs: fix import paths for Workflow and WorkflowResult #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/advanced/composition.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ Chain different workflow patterns together:

```python
from mcp_agent.app import MCPApp
from mcp_agent.workflows import Workflow, WorkflowResult
from mcp_agent.executor.workflow import Workflow, WorkflowResult
from mcp_agent.agents.agent import Agent
from mcp_agent.workflows.llm.augmented_llm_openai import OpenAIAugmentedLLM
from datetime import datetime

app = MCPApp(name="composed_agent")

Expand Down
8 changes: 4 additions & 4 deletions docs/advanced/monitoring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Integrate observability into your MCP Agent workflows:
```python
# workflows/observable_workflow.py
from mcp_agent.app import MCPApp
from mcp_agent.workflows import Workflow, WorkflowResult
from mcp_agent.executor.workflow import Workflow, WorkflowResult
from mcp_agent.agents.agent import Agent
from mcp_agent.workflows.llm.augmented_llm_openai import OpenAIAugmentedLLM
from opentelemetry import trace, metrics
Expand Down Expand Up @@ -1460,7 +1460,7 @@ receivers:
- name: 'critical-alerts'
slack_configs:
- channel: '#critical-alerts'
title: '=¨ CRITICAL: MCP Agent Alert'
title: '=� CRITICAL: MCP Agent Alert'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove stray non-ASCII/control characters in alert title

The title contains unexpected characters (=�). This will render poorly in docs.

-    title: '=� CRITICAL: MCP Agent Alert'
+    title: 'CRITICAL: MCP Agent Alert'
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
title: '=� CRITICAL: MCP Agent Alert'
title: 'CRITICAL: MCP Agent Alert'
🤖 Prompt for AI Agents 
In docs/advanced/monitoring.mdx around line 1463, the alert title contains stray
non-ASCII/control characters ("=�") that will render poorly; remove those
characters and ensure the title contains only valid ASCII or intended Unicode
characters (e.g., change `title: '=� CRITICAL: MCP Agent Alert'` to `title:
'CRITICAL: MCP Agent Alert'` or the correct localized text), then save the file
and run a quick docs build or linter to verify no other control characters
remain.

text: |
{{ range .Alerts }}
*Alert:* {{ .Annotations.summary }}
Expand Down Expand Up @@ -1492,7 +1492,7 @@ receivers:
- name: 'cost-alerts'
slack_configs:
- channel: '#cost-monitoring'
title: '=° LLM Cost Alert'
title: '=� LLM Cost Alert'
text: |
{{ range .Alerts }}
{{ .Annotations.summary }}
Expand Down Expand Up @@ -1633,7 +1633,7 @@ class AlertManager:
if handler:
await handler(alert)

print(f"=¨ ALERT: {alert.severity.value.upper()} - {alert.message}")
print(f"=� ALERT: {alert.severity.value.upper()} - {alert.message}")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix console print artifact

The printed prefix includes a stray character (=�). Use a plain ASCII prefix.

-            print(f"=� ALERT: {alert.severity.value.upper()} - {alert.message}")
+            print(f"ALERT: {alert.severity.value.upper()} - {alert.message}")
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
print(f"=� ALERT: {alert.severity.value.upper()} - {alert.message}")
print(f"ALERT: {alert.severity.value.upper()} - {alert.message}")
🤖 Prompt for AI Agents 
In docs/advanced/monitoring.mdx around line 1636 the printed alert prefix
contains a stray non-ASCII character ("=�"); replace it with a plain ASCII
prefix (for example "=== ALERT:" or "ALERT:") so the print statement uses only
standard ASCII characters and reads clearly.


async def resolve_alert(self, name: str):
"""Resolve alerts by name."""
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/temporal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ mcp-agent supports both `asyncio` and `temporal` execution engines. While asynci
```python worker.py
import asyncio
from mcp_agent.app import MCPApp
from mcp_agent.workflows import Workflow, WorkflowResult
from mcp_agent.executor.workflow import Workflow, WorkflowResult
from mcp_agent.executor.temporal import create_temporal_worker_for_app

app = MCPApp(name="my_agent")
Expand Down Expand Up @@ -484,7 +484,7 @@ Temporal workflows are defined the same way as asyncio workflows:

```python
from mcp_agent.app import MCPApp
from mcp_agent.workflows import Workflow, WorkflowResult
from mcp_agent.executor.workflow import Workflow, WorkflowResult
from mcp_agent.agents.agent import Agent
from mcp_agent.workflows.llm.augmented_llm_openai import OpenAIAugmentedLLM

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Let's create and deploy a simple agent that can fetch web content and summarize
import asyncio
from mcp_agent.app import MCPApp
from mcp_agent.agents.agent import Agent
from mcp_agent.workflows import Workflow, WorkflowResult
from mcp_agent.executor.workflow import Workflow, WorkflowResult
from mcp_agent.workflows.llm.augmented_llm_openai import OpenAIAugmentedLLM

app = MCPApp(name="web_summarizer")
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/workflows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The `Workflow` class is the foundation for building complex agent behaviors. It

```python
from mcp_agent.app import MCPApp
from mcp_agent.workflows import Workflow, WorkflowResult
from mcp_agent.executor.workflow import Workflow, WorkflowResult

app = MCPApp(name="my_agent")

Expand Down
Loading