Skip to content

feat: Support ACP additional directories #191

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

Open
benbrandt wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Support ACP additional directories #191

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
150 changes: 128 additions & 22 deletions src/CodexAcpClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import type {
Model,
SkillsListParams,
SkillsListResponse,
SandboxPolicy,
Thread,
ThreadSourceKind,
TurnCompletedNotification,
Expand All @@ -50,6 +51,7 @@ export class CodexAcpClient {
private pendingLoginCompleted: Promise<AccountLoginCompletedNotification> | null = null;
private pendingAccountUpdated: Promise<AccountUpdatedNotification> | null = null;
private readonly sessionNotificationQueues = new Map<string, Promise<void>>();
private skillExtraRoots: string[] = [];


constructor(codexClient: CodexAppServerClient, codexConfig?: JsonObject, modelProvider?: string) {
Expand Down Expand Up @@ -202,10 +204,11 @@ export class CodexAcpClient {
}

async resumeSession(request: acp.ResumeSessionRequest, onSubscribed?: () => void): Promise<SessionMetadata> {
await this.refreshSkills(request.cwd, request._meta);
const additionalDirectories = readAdditionalDirectories(request.cwd, request.additionalDirectories);
await this.refreshSkills(request.cwd, additionalDirectories, request._meta);

const response = await this.codexClient.threadResume({
config: await this.createSessionConfig(request.cwd, request.mcpServers ?? []),
config: await this.createSessionConfig(request.cwd, additionalDirectories, request.mcpServers ?? []),
cwd: request.cwd,
modelProvider: this.getResumeModelProvider(),
threadId: request.sessionId,
Expand All @@ -218,12 +221,16 @@ export class CodexAcpClient {
currentModelId: currentModelId,
models: codexModels,
currentServiceTier: response.serviceTier as ServiceTier ?? null,
additionalDirectories,
}
}

async loadSession(request: acp.LoadSessionRequest, onSubscribed?: () => void): Promise<SessionMetadataWithThread> {
const additionalDirectories = readAdditionalDirectories(request.cwd, request.additionalDirectories);
await this.refreshSkills(request.cwd, additionalDirectories, request._meta);

const response = await this.codexClient.threadResume({
config: await this.createSessionConfig(request.cwd, request.mcpServers ?? []),
config: await this.createSessionConfig(request.cwd, additionalDirectories, request.mcpServers ?? []),
cwd: request.cwd,
modelProvider: this.getResumeModelProvider(),
threadId: request.sessionId,
Expand All @@ -237,14 +244,16 @@ export class CodexAcpClient {
models: codexModels,
currentServiceTier: response.serviceTier as ServiceTier ?? null,
thread: response.thread,
additionalDirectories,
};
}

async newSession(request: acp.NewSessionRequest): Promise<SessionMetadata> {
await this.refreshSkills(request.cwd, request._meta);
const additionalDirectories = readAdditionalDirectories(request.cwd, request.additionalDirectories);
await this.refreshSkills(request.cwd, additionalDirectories, request._meta);

const response = await this.codexClient.threadStart({
config: await this.createSessionConfig(request.cwd, request.mcpServers),
config: await this.createSessionConfig(request.cwd, additionalDirectories, request.mcpServers),
modelProvider: this.getModelProvider(),
cwd: request.cwd,
});
Expand All @@ -259,6 +268,7 @@ export class CodexAcpClient {
currentModelId: currentModelId,
models: codexModels,
currentServiceTier: response.serviceTier as ServiceTier ?? null,
additionalDirectories,
};
}

Expand All @@ -278,17 +288,21 @@ export class CodexAcpClient {
return this.codexClient.getMcpServerStartupVersion();
}

private async createSessionConfig(projectPath: string, mcpServers: Array<McpServer>): Promise<JsonObject> {
private async createSessionConfig(
projectPath: string,
additionalDirectories: string[],
mcpServers: Array<McpServer>
): Promise<JsonObject> {
const sessionRoots = [projectPath, ...additionalDirectories];
const mergedConfig = {
...mergeGatewayConfig(this.config, this.gatewayConfig),
projects: {
[projectPath]: {
trust_level: "trusted",
}
},
projects: Object.fromEntries(sessionRoots.map(root => [root, {
trust_level: "trusted",
}])),
};
const configWithWorkspaceRoots = mergeSandboxWorkspaceWriteRoots(mergedConfig, additionalDirectories);
if (mcpServers.length === 0) {
return mergedConfig;
return configWithWorkspaceRoots;
}

// Deduplicates new servers against existing config to prevent Codex from deep-merging
Expand All @@ -300,11 +314,11 @@ export class CodexAcpClient {
}));
const uniqueServers = requestedServers.filter(mcp => !existingNames.has(mcp.name));
if (uniqueServers.length === 0) {
return mergedConfig;
return configWithWorkspaceRoots;
}

return {
...mergedConfig,
...configWithWorkspaceRoots,
"mcp_servers": Object.fromEntries(uniqueServers.map(mcp => [mcp.name, this.createMcpSeverConfig(mcp.server)])),
};
}
Expand All @@ -328,17 +342,25 @@ export class CodexAcpClient {
return this.getModelProvider() ?? "openai";
}

private async refreshSkills(cwd: string, meta?: Record<string, unknown> | null): Promise<void> {
private async refreshSkills(
cwd: string,
additionalDirectories: string[],
meta?: Record<string, unknown> | null
): Promise<void> {
if (!cwd) {
return;
}

const additionalRoots = readAdditionalRoots(meta).map(root => path.join(root, ".agents", "skills"));
if (additionalRoots.length > 0) {
const additionalRoots = uniqueStrings([
...readAdditionalRoots(meta),
...additionalDirectories,
]).map(root => path.join(root, ".agents", "skills"));
if (!arraysEqual(this.skillExtraRoots, additionalRoots)) {
await this.codexClient.skillsExtraRootsSet({ extraRoots: additionalRoots });
this.skillExtraRoots = additionalRoots;
}
await this.codexClient.listSkills({
cwds: [cwd],
cwds: [cwd, ...additionalDirectories],
forceReload: true,
});
}
Expand Down Expand Up @@ -444,21 +466,22 @@ export class CodexAcpClient {
serviceTier: ServiceTier | null,
disableSummary: boolean,
cwd: string,
additionalDirectories: string[],
onTurnStarted?: (turnId: string) => void,
shouldCancel?: () => boolean,
): Promise<TurnCompletedNotification | null> {
const input = buildPromptItems(request.prompt);
const effort = modelId.effort as ReasoningEffort | null; //TODO remove unsafe conversion

await this.refreshSkills(cwd, request._meta);
await this.refreshSkills(cwd, additionalDirectories, request._meta);
if (shouldCancel?.()) {
return null;
}
return await this.codexClient.runTurn({
threadId: request.sessionId,
input: input,
approvalPolicy: agentMode.approvalPolicy,
sandboxPolicy: agentMode.sandboxPolicy,
sandboxPolicy: addAdditionalDirectoriesToSandboxPolicy(agentMode.sandboxPolicy, additionalDirectories),
summary: disableSummary ? "none" : null,
effort: effort,
model: modelId.model,
Expand Down Expand Up @@ -641,6 +664,7 @@ export type SessionMetadata = {
currentModelId: string,
models: Model[],
currentServiceTier?: ServiceTier | null,
additionalDirectories: string[],
}

export type SessionMetadataWithThread = SessionMetadata & {
Expand Down Expand Up @@ -701,10 +725,92 @@ function readAdditionalRoots(meta: Record<string, unknown> | null | undefined):
return [];
}

return Array.from(new Set(rawRoots
return uniqueStrings(rawRoots
.filter((value): value is string => typeof value === "string")
.map(value => value.trim())
.filter(value => value.length > 0)));
.filter(value => value.length > 0));
}

function readAdditionalDirectories(cwd: string, rawDirectories: unknown): string[] {
if (rawDirectories === undefined) {
return [];
}
if (rawDirectories === null) {
throw RequestError.invalidParams(undefined, "additionalDirectories must be an array");
}
if (!Array.isArray(rawDirectories)) {
throw RequestError.invalidParams(undefined, "additionalDirectories must be an array");
}

const directories: string[] = [];
const seen = new Set<string>([cwd]);
for (const directory of rawDirectories) {
if (typeof directory !== "string") {
throw RequestError.invalidParams(undefined, "additionalDirectories entries must be strings");
}
if (directory.length === 0) {
throw RequestError.invalidParams(undefined, "additionalDirectories entries must not be empty");
}
if (!path.isAbsolute(directory)) {
throw RequestError.invalidParams(undefined, "additionalDirectories entries must be absolute paths");
}
if (!seen.has(directory)) {
seen.add(directory);
directories.push(directory);
}
}

return directories;
}

function mergeSandboxWorkspaceWriteRoots(config: JsonObject, roots: string[]): JsonObject {
if (roots.length === 0) {
return config;
}

const existingSandboxConfig = isJsonObject(config["sandbox_workspace_write"])
? config["sandbox_workspace_write"]
: {};
const existingWritableRoots = Array.isArray(existingSandboxConfig["writable_roots"])
? existingSandboxConfig["writable_roots"].filter((value): value is string => typeof value === "string")
: [];

return {
...config,
sandbox_workspace_write: {
...existingSandboxConfig,
writable_roots: uniqueStrings([...existingWritableRoots, ...roots]),
},
};
}

function addAdditionalDirectoriesToSandboxPolicy(
sandboxPolicy: SandboxPolicy,
additionalDirectories: string[]
): SandboxPolicy {
if (additionalDirectories.length === 0 || sandboxPolicy.type !== "workspaceWrite") {
return sandboxPolicy;
}

return {
...sandboxPolicy,
writableRoots: uniqueStrings([...sandboxPolicy.writableRoots, ...additionalDirectories]),
};
}

function uniqueStrings(values: string[]): string[] {
return Array.from(new Set(values));
}

function arraysEqual(left: string[], right: string[]): boolean {
if (left.length !== right.length) {
return false;
}
return left.every((value, index) => value === right[index]);
}

function isJsonObject(value: JsonValue | undefined): value is JsonObject {
return value !== null && typeof value === "object" && !Array.isArray(value);
}

function mergeGatewayConfig(config: JsonObject, gatewayConfig: GatewayConfig | null): JsonObject {
Expand Down
20 changes: 19 additions & 1 deletion src/CodexAcpServer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ export interface SessionState {
rateLimits: RateLimitsMap | null;
account: Account | null;
cwd: string;
additionalDirectories: string[];
fastModeEnabled: boolean;
currentModelSupportsFast: boolean;
sessionMcpServers?: Array<string>;
Expand Down Expand Up @@ -160,6 +161,7 @@ export class CodexAcpServer implements acp.Agent {
resume: { },
list: { },
close: { },
additionalDirectories: {},
},
mcpCapabilities: {
acp: false,
Expand Down Expand Up @@ -346,6 +348,7 @@ export class CodexAcpServer implements acp.Agent {
rateLimits: null,
account: account,
cwd: request.cwd,
additionalDirectories: sessionMetadata.additionalDirectories,
fastModeEnabled: sessionMetadata.currentServiceTier === "fast",
currentModelSupportsFast: currentModelSupportsFast,
sessionMcpServers: sessionMcpServers,
Expand Down Expand Up @@ -418,7 +421,20 @@ export class CodexAcpServer implements acp.Agent {
async listSessions(params: acp.ListSessionsRequest): Promise<acp.ListSessionsResponse> {
logger.log("Listing sessions...", {cwd: params.cwd, cursor: params.cursor});
await this.checkAuthorization();
return await this.runWithProcessCheck(() => this.codexAcpClient.listSessions(params));
const response = await this.runWithProcessCheck(() => this.codexAcpClient.listSessions(params));
return {
...response,
sessions: response.sessions.map((session) => {
const activeSession = this.sessions.get(session.sessionId);
if (!activeSession || activeSession.additionalDirectories.length === 0) {
return session;
}
return {
...session,
additionalDirectories: activeSession.additionalDirectories,
};
}),
};
}

async closeSession(params: acp.CloseSessionRequest): Promise<acp.CloseSessionResponse> {
Expand Down Expand Up @@ -735,6 +751,7 @@ export class CodexAcpServer implements acp.Agent {
rateLimits: null,
account: account,
cwd: request.cwd,
additionalDirectories: sessionMetadata.additionalDirectories,
fastModeEnabled: sessionMetadata.currentServiceTier === "fast",
currentModelSupportsFast: currentModelSupportsFast,
sessionMcpServers: sessionMcpServers,
Expand Down Expand Up @@ -1270,6 +1287,7 @@ export class CodexAcpServer implements acp.Agent {
serviceTier,
disableSummary,
sessionState.cwd,
sessionState.additionalDirectories,
(turnId) => {
if (this.promptIsClosedOrStale(params.sessionId, activePrompt)) {
this.interruptLateStartedTurn(params.sessionId, turnId);
Expand Down
Loading
Loading