Skip to content

Commit 241bfb0

Browse files
committed
Minor updates
1 parent d7e2202 commit 241bfb0

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

docs/develop/ai-tools/writing-tables.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ Build the plugin and verify the [resource type] table was properly registered wi
9191
# Steps
9292
9393
1. Build the plugin using `make dev` to compile a plugin if available, else use `make`.
94-
2. Check if the Steampipe service is running with `steampipe service status`.
95-
- If it's not running, start it using `steampipe service start`.
96-
- If it is already running, restart it using `steampipe service restart`.
94+
2. Check if the Steampipe service is running with `steampipe service status`. If it's not running, start it using `steampipe service start`, else restart it using `steampipe service restart`.
9795
3. Test if the Steampipe MCP server is available by running the `steampipe_table_list` tool.
9896
4. Verify the table exists in the schema and basic querying works using the guidelines below.
9997
@@ -111,16 +109,10 @@ Build the plugin and verify the [resource type] table was properly registered wi
111109
Build the plugin and verify the [resource type] table was properly registered with the plugin using the following guidelines.
112110
113111
1. Build the plugin using `make dev` to compile a plugin if available, else use `make`.
114-
2. Check if the Steampipe service is running with `steampipe service status`
115-
- If it's not running, start it using `steampipe service start`.
116-
- If it is already running, restart it using `steampipe service restart`.
112+
2. Check if the Steampipe service is running with `steampipe service status`. If it's not running, start it using `steampipe service start`, else restart it using `steampipe service restart`.
117113
3. Test if the Steampipe MCP server is available by running the `steampipe_table_list` tool.
118-
4. If the Steampipe MCP server is available, you MUST use it to:
119-
1. Verify the table exists in the schema.
120-
2. Verify the table can be queried successfully.
121-
5. If the Steampipe MCP server is not available:
122-
1. Use `steampipe query "SELECT column_name, data_type FROM information_schema.columns WHERE table_schema = '[plugin_name]' AND table_name = '[table_name]' ORDER BY ordinal_position"` to verify the table exists.
123-
2. Use `steampipe query "select * from [table_name]"` to verify basic querying works.
114+
4. If the Steampipe MCP server is available, you MUST use it to verify the table exists in the schema and then verify the table can be queried successfully.
115+
5. If the Steampipe MCP server is not available, use `steampipe query "SELECT column_name, data_type FROM information_schema.columns WHERE table_schema = '[plugin_name]' AND table_name = '[table_name]' ORDER BY ordinal_position"` to verify the table exists. Then use `steampipe query "select * from [table_name]"` to verify basic querying works.
124116
```
125117

126118
## Create Test Resources
@@ -167,7 +159,8 @@ Test the implementation for [resource type] by querying resources and validating
167159
```
168160
Test the implementation for [resource type] by querying resources and validating column data.
169161
170-
Use the Steampipe MCP server to run test queries. If the Steampipe MCP server is not available, use `steampipe` CLI commands.
162+
Use the Steampipe MCP server to run test queries. If the Steampipe MCP server is not available,
163+
use `steampipe` CLI commands.
171164
172165
Share all test results in raw Markdown format to make them easy to export.
173166
@@ -200,7 +193,6 @@ Remove all [resource type] resources used for testing.
200193
```
201194
Remove all [resource type] resources used for testing.
202195
203-
Using the same method used to create the resources, delete all resources used for testing (including dependent resources).
204-
205-
Then verify the resources were deleted.
196+
Using the same method used to create the resources, delete all resources used for
197+
testing (including dependent resources) and verify they were deleted.
206198
```

0 commit comments

Comments
 (0)