Skip to content

Commit ef8f7a9

Browse files
committed
Update tooling information
1 parent 6e59116 commit ef8f7a9

File tree

1 file changed

+37
-289
lines changed

1 file changed

+37
-289
lines changed

README.md

Lines changed: 37 additions & 289 deletions
Original file line numberDiff line numberDiff line change
@@ -131,295 +131,43 @@ npx "your/folders/full/path" -y @octopusdeploy/mcp-server
131131

132132
## 🔨 Tools
133133

134-
<details>
135-
<summary>list_spaces</summary>
136-
137-
**Description**: List all spaces in the Octopus Deploy instance
138-
139-
**Parameters**: None
140-
141-
</details>
142-
143-
<details>
144-
<summary>list_projects</summary>
145-
146-
**Description**: List projects in a space
147-
148-
This tool lists all projects in a given space. The space name is required; if you can't find the space name, ask the user directly for the name of the space. Optionally filter by partial name match using partialName parameter.
149-
150-
**Parameters**:
151-
- `spaceName` (string, required): The space name
152-
- `partialName` (string, optional): Filter by partial name match
153-
154-
</details>
155-
156-
<details>
157-
<summary>list_environments</summary>
158-
159-
**Description**: List environments in a space
160-
161-
This tool lists all environments in a given space. The space name is required. Optionally filter by partial name match using partialName parameter.
162-
163-
**Parameters**:
164-
- `spaceName` (string, required): The space name
165-
- `partialName` (string, optional): Filter by partial name match
166-
167-
</details>
168-
169-
<details>
170-
<summary>list_deployments</summary>
171-
172-
**Description**: List deployments in a space
173-
174-
This tool lists deployments in a given space. The space name is required. Optional filters include: projects (array of project IDs), environments (array of environment IDs), tenants (array of tenant IDs), channels (array of channel IDs), taskState (one of: Canceled, Cancelling, Executing, Failed, Queued, Success, TimedOut), and take (number of results to return).
175-
176-
**Parameters**:
177-
- `spaceName` (string, required): The space name
178-
- `projects` (array of strings, optional): Array of project IDs to filter by
179-
- `environments` (array of strings, optional): Array of environment IDs to filter by
180-
- `tenants` (array of strings, optional): Array of tenant IDs to filter by
181-
- `channels` (array of strings, optional): Array of channel IDs to filter by
182-
- `taskState` (string, optional): One of: Canceled, Cancelling, Executing, Failed, Queued, Success, TimedOut
183-
- `take` (number, optional): Number of results to return
184-
185-
</details>
186-
187-
<details>
188-
<summary>get_release_by_id</summary>
189-
190-
**Description**: Get details for a specific release by its ID
191-
192-
**Parameters**:
193-
- `spaceName` (string, required): The space name
194-
- `releaseId` (string, required): The ID of the release to retrieve
195-
196-
</details>
197-
198-
<details>
199-
<summary>list_releases</summary>
200-
201-
**Description**: List releases in a space
202-
203-
This tool lists all releases in a given space. The space name is required. Optionally provide skip and take parameters for pagination.
204-
205-
**Parameters**:
206-
- `spaceName` (string, required): The space name
207-
- `skip` (number, optional): Number of items to skip for pagination
208-
- `take` (number, optional): Number of items to take for pagination
209-
210-
</details>
211-
212-
<details>
213-
<summary>list_releases_for_project</summary>
214-
215-
**Description**: List releases for a specific project
216-
217-
This tool lists all releases for a given project in a space. The space name and project ID are required. Optionally provide skip, take, and searchByVersion parameters.
218-
219-
**Parameters**:
220-
- `spaceName` (string, required): The space name
221-
- `projectId` (string, required): The ID of the project to list releases for
222-
- `skip` (number, optional): Number of items to skip for pagination
223-
- `take` (number, optional): Number of items to take for pagination
224-
- `searchByVersion` (string, optional): Search releases by version string
225-
226-
</details>
227-
228-
<details>
229-
<summary>get_task_by_id</summary>
230-
231-
**Description**: Get details for a specific server task by its ID
232-
233-
**Parameters**:
234-
- `spaceName` (string, required): The space name
235-
- `taskId` (string, required): The ID of the task to retrieve
236-
237-
</details>
238-
239-
<details>
240-
<summary>get_task_details</summary>
241-
242-
**Description**: Get detailed information for a specific server task by its ID
243-
244-
**Parameters**:
245-
- `spaceName` (string, required): The space name
246-
- `taskId` (string, required): The ID of the task to retrieve
247-
248-
</details>
249-
250-
<details>
251-
<summary>get_task_raw</summary>
252-
253-
**Description**: Get raw details for a specific server task by its ID
254-
255-
**Parameters**:
256-
- `spaceName` (string, required): The space name
257-
- `taskId` (string, required): The ID of the task to retrieve
258-
259-
</details>
260-
261-
<details>
262-
<summary>list_deployment_targets</summary>
263-
264-
**Description**: List deployment targets (machines) in a space
265-
266-
This tool lists all deployment targets in a given space. The space name is required. You can optionally filter by various parameters like name, roles, health status, etc.
267-
268-
**Parameters**:
269-
- `spaceName` (string, required): The space name
270-
- `skip` (number, optional): Number of items to skip for pagination
271-
- `take` (number, optional): Number of items to take for pagination
272-
- `name` (string, optional): Filter by exact name match
273-
- `ids` (array of strings, optional): Array of deployment target IDs to filter by
274-
- `partialName` (string, optional): Filter by partial name match
275-
- `roles` (array of strings, optional): Array of roles to filter by
276-
- `isDisabled` (boolean, optional): Filter by disabled status
277-
- `healthStatuses` (array of strings, optional): Array of health statuses to filter by
278-
- `commStyles` (array of strings, optional): Array of communication styles to filter by
279-
- `tenantIds` (array of strings, optional): Array of tenant IDs to filter by
280-
- `tenantTags` (array of strings, optional): Array of tenant tags to filter by
281-
- `environmentIds` (array of strings, optional): Array of environment IDs to filter by
282-
- `thumbprint` (string, optional): Filter by certificate thumbprint
283-
- `deploymentId` (string, optional): Filter by deployment ID
284-
- `shellNames` (array of strings, optional): Array of shell names to filter by
285-
- `deploymentTargetTypes` (array of strings, optional): Array of deployment target types to filter by
286-
287-
</details>
288-
289-
<details>
290-
<summary>get_deployment_target</summary>
291-
292-
**Description**: Get a specific deployment target (machine) by ID
293-
294-
This tool retrieves detailed information about a specific deployment target using its ID. The space name and target ID are both required.
295-
296-
**Parameters**:
297-
- `spaceName` (string, required): The space name
298-
- `targetId` (string, required): The ID of the deployment target to retrieve
299-
300-
</details>
301-
302-
<details>
303-
<summary>get_deployment_process</summary>
304-
305-
**Description**: Get deployment process by ID
306-
307-
This tool retrieves a deployment process by its ID. Each project has a deployment process attached, and releases/deployments can also have frozen processes attached.
308-
309-
**Parameters**:
310-
- `spaceName` (string, required): The space name
311-
- `projectId` (string, optional): The ID of the project to retrieve the deployment process for. If processId is not provided, this parameter is required.
312-
- `processId` (string, optional): The ID of the deployment process to retrieve. If not provided, the deployment process for the project will be retrieved.
313-
- `branchName` (string, optional): Optional branch name to get the deployment process for a specific branch (if using version controlled projects). Try `main` or `master` if unsure.
314-
- `includeDetails` (boolean, optional): Include detailed properties for steps and actions. Defaults to false.
315-
316-
</details>
317-
318-
<details>
319-
<summary>get_branches</summary>
320-
321-
**Description**: Get Git branches for a version-controlled project
322-
323-
This tool retrieves Git branches for a specific project in a space. The space name and project ID are required. Optionally provide searchByName, skip, and take parameters for filtering and pagination.
324-
325-
**Parameters**:
326-
- `spaceName` (string, required): The space name
327-
- `projectId` (string, required): The ID of the project
328-
- `searchByName` (string, optional): Filter branches by partial name match
329-
- `skip` (number, optional): Number of items to skip for pagination
330-
- `take` (number, optional): Number of items to take for pagination
331-
332-
</details>
333-
334-
<details>
335-
<summary>list_tenants</summary>
336-
337-
**Description**: List tenants in a space
338-
339-
This tool lists all tenants in a given space. The space name is required. Optionally provide skip and take parameters for pagination.
340-
341-
**Parameters**:
342-
- `spaceName` (string, required): The space name
343-
- `skip` (number, optional): Number of items to skip for pagination
344-
- `take` (number, optional): Number of items to take for pagination
345-
- `ids` (array of strings, optional): Filter by specific tenant IDs
346-
- `partialName` (string, optional): Filter by partial tenant name match
347-
- `projectId` (string, optional): Filter by specific project ID
348-
- `tags` (string, optional): Filter by tenant tags (comma-separated list)
349-
350-
</details>
351-
352-
<details>
353-
<summary>get_tenant_by_id</summary>
354-
355-
**Description**: Get details for a specific tenant by its ID
356-
357-
**Parameters**:
358-
- `spaceName` (string, required): The space name
359-
- `tenantId` (string, required): The ID of the tenant to retrieve
360-
361-
</details>
362-
363-
<details>
364-
<summary>get_tenant_variables</summary>
365-
366-
**Description**: Get tenant variables by type
367-
368-
This tool retrieves different types of tenant variables. Use variableType parameter to specify which type:
369-
- "all": Get all tenant variables
370-
- "common": Get common variables only
371-
- "project": Get project-specific variables only
372-
373-
**Parameters**:
374-
- `spaceName` (string, required): The space name
375-
- `tenantId` (string, required): The ID of the tenant to retrieve variables for
376-
- `variableType` (string, required): Type of variables to retrieve (all, common, project)
377-
- `includeMissingVariables` (boolean, optional): Include missing variables in the response (for common/project types)
378-
379-
</details>
380-
381-
<details>
382-
<summary>get_missing_tenant_variables</summary>
383-
384-
**Description**: Get missing tenant variables
385-
386-
This tool retrieves tenant variables that are missing values. Optionally filter by tenant, project, or environment.
387-
388-
**Parameters**:
389-
- `spaceName` (string, required): The space name
390-
- `tenantId` (string, optional): Filter by specific tenant ID
391-
- `projectId` (string, optional): Filter by specific project ID
392-
- `environmentId` (string, optional): Filter by specific environment ID
393-
- `includeDetails` (boolean, optional): Include detailed information about missing variables
394-
395-
</details>
396-
397-
<details>
398-
<summary>get_kubernetes_live_status</summary>
399-
400-
**Description**: Get Kubernetes live status for a project and environment
401-
402-
This tool retrieves the live status of Kubernetes resources for a specific project and environment. Optionally include a tenant ID for multi-tenant deployments.
403-
404-
**Parameters**:
405-
- `spaceName` (string, required): The space name
406-
- `projectId` (string, required): The ID of the project
407-
- `environmentId` (string, required): The ID of the environment
408-
- `tenantId` (string, optional): The ID of the tenant (for multi-tenant deployments)
409-
- `summaryOnly` (boolean, optional): Return summary information only
410-
411-
</details>
412-
413-
<details>
414-
<summary>get_current_user</summary>
415-
416-
**Description**: Get information about the current authenticated user
417-
418-
This tool retrieves information about the currently authenticated user from the Octopus Deploy API.
419-
420-
**Parameters**: None
421-
422-
</details>
134+
### Core Tools
135+
- `list_spaces`: List all spaces in the Octopus Deploy instance
136+
- `list_environments`: List all environments in a given space
137+
138+
### Projects
139+
- `list_projects`: List all projects in a given space
140+
141+
### Deployments
142+
- `list_deployments`: List deployments in a space with optional filtering
143+
144+
### Releases
145+
- `get_release_by_id`: Get details for a specific release by its ID
146+
- `list_releases`: List all releases in a given space
147+
- `list_releases_for_project`: List all releases for a specific project
148+
149+
### Tasks
150+
- `get_task_by_id`: Get details for a specific server task by its ID
151+
- `get_task_details`: Get detailed information for a specific server task
152+
- `get_task_raw`: Get raw details for a specific server task
153+
154+
### Tenants
155+
- `list_tenants`: List all tenants in a given space
156+
- `get_tenant_by_id`: Get details for a specific tenant by its ID
157+
- `get_tenant_variables`: Get tenant variables by type (all, common, or project)
158+
- `get_missing_tenant_variables`: Get tenant variables that are missing values
159+
160+
### Kubernetes
161+
- `get_kubernetes_live_status`: Get live status of Kubernetes resources for a project and environment (only supported in Octopus Server starting with version `2025.3`)
162+
163+
### Machines (Deployment Targets)
164+
- `list_deployment_targets`: List all deployment targets in a space with optional filtering
165+
- `get_deployment_target`: Get detailed information about a specific deployment target
166+
167+
### Additional Tools
168+
- `get_deployment_process`: Get deployment process by ID for projects or releases
169+
- `get_branches`: Get Git branches for a version-controlled project
170+
- `get_current_user`: Get information about the current authenticated user
423171

424172
## Security Considerations
425173

0 commit comments

Comments
 (0)