You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/ai-tools/writing-tables.md
+8-16Lines changed: 8 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -91,9 +91,7 @@ Build the plugin and verify the [resource type] table was properly registered wi
91
91
# Steps
92
92
93
93
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`.
97
95
3. Test if the Steampipe MCP server is available by running the `steampipe_table_list` tool.
98
96
4. Verify the table exists in the schema and basic querying works using the guidelines below.
99
97
@@ -111,16 +109,10 @@ Build the plugin and verify the [resource type] table was properly registered wi
111
109
Build the plugin and verify the [resource type] table was properly registered with the plugin using the following guidelines.
112
110
113
111
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`.
117
113
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.
124
116
```
125
117
126
118
## Create Test Resources
@@ -167,7 +159,8 @@ Test the implementation for [resource type] by querying resources and validating
167
159
```
168
160
Test the implementation for [resource type] by querying resources and validating column data.
169
161
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.
171
164
172
165
Share all test results in raw Markdown format to make them easy to export.
173
166
@@ -200,7 +193,6 @@ Remove all [resource type] resources used for testing.
200
193
```
201
194
Remove all [resource type] resources used for testing.
202
195
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.
0 commit comments