AS AgentScopeAPI 手册 / API Reference

WorkspaceContextMiddleware

public class WorkspaceContextMiddleware implements HarnessRuntimeMiddleware
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:50–595

工作区上下文中间件,在智能体执行流程中提供横切扩展。位于 io.agentscope.harness.agent.middleware 包,实现 HarnessRuntimeMiddleware。核心成员包括 setAdditionalContextFiles、isDisableMemoryTools、isDisableMemoryHooks、setArtifactDeliveryEnabled、onSystemPrompt、WorkspaceContextMiddleware。

Appends workspace context (session info, AGENTS.md, MEMORY.md, knowledge) to the system prompt via #onSystemPrompt(Agent, RuntimeContext, String).

Runs once per call() (just like the previous WorkspaceContextHook fired on PreCallEvent).

Memory-related guidance and <memory_context> injection are gated by the same builder flags as Harness memory tools/hooks (disableMemoryTools / disableMemoryHooks) so the model is not instructed to use capabilities that are turned off.

构造器摘要Constructor Summary

构造器Constructor说明Description
public WorkspaceContextMiddleware(WorkspaceManager workspaceManager)
初始化 `WorkspaceContextMiddleware` 实例。
Creates a new instance.
public WorkspaceContextMiddleware(WorkspaceManager workspaceManager, int maxContextTokens)
初始化 `WorkspaceContextMiddleware` 实例。
Creates a new instance.
public WorkspaceContextMiddleware(WorkspaceManager workspaceManager, String agentName, String environmentMemory, int maxContextTokens)
初始化 `WorkspaceContextMiddleware` 实例。
Creates a new instance.
public WorkspaceContextMiddleware(WorkspaceManager workspaceManager, String agentName, String environmentMemory, int maxContextTokens, boolean disableMemoryTools, boolean disableMemoryHooks)
初始化 `WorkspaceContextMiddleware` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public void setAdditionalContextFiles(List<String> files)
设置 `setAdditionalContextFiles`。
Sets the additional context files.
public boolean isDisableMemoryTools()
判断是否禁用记忆工具。
Whether memory tools are disabled for this middleware (affects prompt guidance).
public boolean isDisableMemoryHooks()
判断是否 `isDisableMemoryHooks`。
Whether memory hooks are disabled for this middleware (affects prompt guidance).
public void setArtifactDeliveryEnabled(boolean artifactDeliveryEnabled)
设置 `setArtifactDeliveryEnabled`。
Whether an `io.agentscope.harness.agent.artifact.ArtifactDeliveryTarget` is configured and the `deliver_artifact` tool is exposed.
public Mono<String> onSystemPrompt(Agent agent, RuntimeContext ctx, String currentPrompt)
处理系统提示词事件。
Performs the on system prompt operation.

构造器详情Constructor Detail

WorkspaceContextMiddleware

public WorkspaceContextMiddleware(WorkspaceManager workspaceManager)

初始化 WorkspaceContextMiddleware 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
workspaceManagerWorkspaceManager工作区管理器(类型 `WorkspaceManager`)。The workspace manager.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:139–141

WorkspaceContextMiddleware

public WorkspaceContextMiddleware(WorkspaceManager workspaceManager, int maxContextTokens)

初始化 WorkspaceContextMiddleware 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
workspaceManagerWorkspaceManager工作区管理器(类型 `WorkspaceManager`)。The workspace manager.
maxContextTokensint最大上下文令牌数(类型 `int`)。The max context tokens.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:143–145

WorkspaceContextMiddleware

public WorkspaceContextMiddleware(WorkspaceManager workspaceManager, String agentName, String environmentMemory, int maxContextTokens)

初始化 WorkspaceContextMiddleware 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
workspaceManagerWorkspaceManager工作区管理器(类型 `WorkspaceManager`)。The workspace manager.
agentNameString智能体名称(类型 `String`)。The agent name.
environmentMemoryString环境记忆(类型 `String`)。The environment memory.
maxContextTokensint最大上下文令牌数(类型 `int`)。The max context tokens.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:147–153

WorkspaceContextMiddleware

public WorkspaceContextMiddleware(WorkspaceManager workspaceManager, String agentName, String environmentMemory, int maxContextTokens, boolean disableMemoryTools, boolean disableMemoryHooks)

初始化 WorkspaceContextMiddleware 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
workspaceManagerWorkspaceManager工作区管理器(类型 `WorkspaceManager`)。The workspace manager.
agentNameString智能体名称(类型 `String`)。The agent name.
environmentMemoryString环境记忆(类型 `String`)。The environment memory.
maxContextTokensint最大上下文令牌数(类型 `int`)。The max context tokens.
disableMemoryToolsboolean禁用记忆工具(类型 `boolean`)。The disable memory tools.
disableMemoryHooksboolean禁用记忆 Hooks(类型 `boolean`)。The disable memory hooks.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:155–168

方法详情Method Detail

setAdditionalContextFiles

public void setAdditionalContextFiles(List<String> files)

设置 setAdditionalContextFiles。

Sets the additional context files.

参数Parameters
名称Name类型Type说明Description
filesList<String>文件(类型 `List`)。The files.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:170–172

isDisableMemoryTools

public boolean isDisableMemoryTools()

判断是否禁用记忆工具。

Whether memory tools are disabled for this middleware (affects prompt guidance).

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:177–179

isDisableMemoryHooks

public boolean isDisableMemoryHooks()

判断是否 isDisableMemoryHooks。

Whether memory hooks are disabled for this middleware (affects prompt guidance).

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:184–186

setArtifactDeliveryEnabled

public void setArtifactDeliveryEnabled(boolean artifactDeliveryEnabled)

设置 setArtifactDeliveryEnabled。

Whether an io.agentscope.harness.agent.artifact.ArtifactDeliveryTarget is configured and the deliver_artifact tool is exposed.

参数Parameters
名称Name类型Type说明Description
artifactDeliveryEnabledbooleanartifact Delivery 已启用(类型 `boolean`)。The artifact delivery enabled.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:194–196

onSystemPrompt

public Mono<String> onSystemPrompt(Agent agent, RuntimeContext ctx, String currentPrompt)

处理系统提示词事件。

Performs the on system prompt operation.

参数Parameters
名称Name类型Type说明Description
agentAgent智能体(类型 `Agent`)。The agent.
ctxRuntimeContext运行时上下文(类型 `RuntimeContext`)。The ctx.
currentPromptString当前提示词(类型 `String`)。The current prompt.
返回Returns Mono<String>
返回Mono。Returns mono.
源码Source io/agentscope/harness/agent/middleware/WorkspaceContextMiddleware.java:198–209

继承成员Inherited Members

继承自Methods inherited from MiddlewareBase
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.