feat: expose deployment log reader#54
Open
agentHits wants to merge 1 commit into
Open
Conversation
Что: - синхронизированы generated Dokploy OpenAPI tools с текущим upstream spec, включая `deployment-readLogs`; - обновлена generated tools documentation; - добавлены regression tests для `tools/list` и `tools/call` маршрутизации `deployment-readLogs`. Зачем: - MCP clients смогут читать deployment logs для вручную запущенных schedule runs и сохранять command output как audit evidence. Риски: - live Dokploy schedule execution не проверялся, потому что реальный instance, secrets и infrastructure не использовались. Проверки: - Команды и результаты: `corepack pnpm exec vitest run src/server.test.ts --reporter=verbose` прошел, 1 file / 6 tests; `corepack pnpm run lint` прошел с одним существующим warning в `src/utils/responseFormatter.ts`; `corepack pnpm run type-check` прошел; `corepack pnpm run test` прошел, 3 files / 27 tests; `corepack pnpm run build` прошел; `git diff --check` прошел; independent Agent Flow QA вернул pass. - Ограничения: live Dokploy API schedule log retrieval не проверялся. What: - synchronized generated Dokploy OpenAPI tools with the current upstream spec, including `deployment-readLogs`; - updated the generated tools documentation; - added regression tests for `tools/list` exposure and `tools/call` routing for `deployment-readLogs`. Why: - MCP clients can read deployment logs for manually triggered schedule runs and capture command output as audit evidence. Risks: - live Dokploy schedule execution was not tested because no real instance, secrets, or infrastructure were used. Checks: - Commands and results: `corepack pnpm exec vitest run src/server.test.ts --reporter=verbose` passed, 1 file / 6 tests; `corepack pnpm run lint` passed with one existing warning in `src/utils/responseFormatter.ts`; `corepack pnpm run type-check` passed; `corepack pnpm run test` passed, 3 files / 27 tests; `corepack pnpm run build` passed; `git diff --check` passed; independent Agent Flow QA returned pass. - Limitations: live Dokploy API schedule log retrieval was not exercised. Closes Dokploy#53
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 23873361d9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| method: "POST", | ||
| path: "/server.update", | ||
| schema: z.object({ "name": z.string().min(1), "description": z.union([z.string(), z.null()]), "serverId": z.string().min(1), "ipAddress": z.string(), "port": z.number(), "username": z.string(), "sshKeyId": z.union([z.string(), z.null()]), "serverType": z.enum(["deploy","build"]), "command": z.string().optional() }), | ||
| schema: z.object({ "name": z.string().min(1), "description": z.union([z.string(), z.null()]), "serverId": z.string().min(1), "ipAddress": z.string(), "port": z.number(), "username": z.string(), "sshKeyId": z.union([z.string(), z.null()]), "serverType": z.enum(["deploy","build"]), "enableDockerCleanup": z.boolean().default(true), "command": z.string().optional() }), |
There was a problem hiding this comment.
When a caller updates a server that currently has Docker cleanup disabled and omits enableDockerCleanup, this Zod default is applied before the handler posts the parsed arguments, so the request includes enableDockerCleanup: true and silently re-enables cleanup. The OpenAPI required list leaves this field optional for server-update, so the generated client should preserve omission or require/fetch the existing value rather than turning every update into true.
Useful? React with 👍 / 👎.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #53.
This syncs the generated Dokploy OpenAPI artifacts with the current published spec so the MCP server exposes
deployment-readLogs.That gives schedule users a direct way to read the deployment log created by a manual schedule run:
deployment-readLogsis now included intools/list.deployment-readLogsroutestools/calltoGET /deployment.readLogswithdeploymentIdand optionaltail.TOOLS.mdnow documents the generated deployment log reader.The sync also pulls in the other endpoints currently present in the published Dokploy OpenAPI spec but missing from
src/generated/openapi.json.Testing
corepack pnpm exec vitest run src/server.test.ts --reporter=verbosecorepack pnpm run lintcorepack pnpm run type-checkcorepack pnpm run testcorepack pnpm run buildgit diff --checkNote:
pnpm run lintpasses with the existingsrc/utils/responseFormatter.tsstatic-only class warning.QA
Independent Agent Flow QA rechecked the final diff and returned
pass.Live Dokploy schedule execution was not tested because this PR does not use a real Dokploy instance, secrets, Docker, or deployment infrastructure.