Skip to content

Commit 6056460

Browse files
committed
docs: change get_images docstring to sphinx style
1 parent b95d3b7 commit 6056460

File tree

3 files changed

+8
-73
lines changed

3 files changed

+8
-73
lines changed
Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +0,0 @@
1-
from fastmcp import FastMCP
2-
3-
4-
def register_prompt(mcp: FastMCP):
5-
"""
6-
Register OpenStack MCP prompts.
7-
"""
8-
9-
# Add image tools prompt
10-
mcp.add_prompt(
11-
"image_tools",
12-
"ImageTools Usage Guide - Only use parameters that the user explicitly requests",
13-
"prompts/image_tools_prompt.md",
14-
)

src/openstack_mcp_server/prompts/image_tools_prompt.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

src/openstack_mcp_server/tools/image_tools.py

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,14 @@ def get_images(
2828
"""
2929
Get the list of OpenStack images with optional filtering.
3030
31-
Prompt:
32-
See prompts/image_tools_prompt.md for detailed usage examples.
33-
34-
Args:
35-
name: Filter by image name
36-
status: Filter by status (e.g., 'active', 'queued', 'killed')
37-
visibility: Filter by visibility (e.g., 'public', 'private', 'shared')
38-
39-
Returns:
40-
A list of Image objects.
31+
The filtering behavior is as follows:
32+
- By default, all available images are returned without any filtering applied.
33+
- Filters are only applied when specific values are provided by the user.
34+
35+
:param name: Filter by image name
36+
:param status: Filter by status
37+
:param visibility: Filter by visibility
38+
:return: A list of Image objects.
4139
"""
4240
conn = get_openstack_conn()
4341

0 commit comments

Comments
 (0)