Skip to content

Commit 494732a

Browse files
dividordividor
committed
docs: update README with new tools and MCP integration path
- Added all 11 tools to Available Tools section with complete descriptions - Organized tools into Core Search, Agency-Specific, and ChatGPT Connector categories - Updated MCP integration examples to include 'cwd' path for proper working directory - Added exact tool descriptions and parameters from remote server - Improved documentation structure with clear tool categorization
1 parent 7ea9326 commit 494732a

File tree

1 file changed

+123
-17
lines changed

1 file changed

+123
-17
lines changed

‎README.md‎

Lines changed: 123 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,21 @@ Add this configuration to your MCP client config file:
114114
"run",
115115
"pia-mcp-server",
116116
"--api-key", "YOUR_API_KEY"
117-
]
117+
],
118+
"cwd": "/path/to/your/pia-mcp-local"
118119
}
119120
}
120121
}
121122
```
122123

123124
For Docker:
124125

126+
You must build the Docker image ...
127+
128+
`docker build -t pia-mcp-server:latest .`
129+
130+
Then add this to your Client, eg Claude ...
131+
125132
```json
126133
{
127134
"mcpServers": {
@@ -141,57 +148,156 @@ For Docker:
141148

142149
## 💡 Available Tools
143150

144-
The server provides four main tools for searching the Program Integrity Alliance (PIA) database:
151+
The server provides 11 tools for searching the Program Integrity Alliance (PIA) database:
152+
153+
### Core Search Tools
145154

146155
### 1. `pia_search_content`
147156

148157
**Purpose:** Comprehensive search tool for querying document content and recommendations in the PIA database.
149158

150-
**Description:** Returns comprehensive results with full citation information and clickable links for proper attribution. Each result includes corresponding citations with data source attribution (GAO, OIG, etc.). Supports complex OData filtering with boolean logic, operators, and grouping.
159+
**Description:** Returns comprehensive results with full citation information and clickable links for proper attribution. Each result includes corresponding citations with data source attribution. Major data sources include: Department of Justice (198k+ docs), Congress.gov (29k+ docs), Oversight.gov (22k+ docs), CRS (22k+ docs), GAO (10k+ docs). Supports complex OData filtering with boolean logic, operators, and grouping.
151160

152161
**Parameters:**
153162
- `query` (required): Search query text
154163
- `filter` (optional): OData filter expression supporting complex boolean logic
155-
- `page` (optional): Page number (1-based, default: 1)
156-
- `page_size` (optional): Number of results per page (max 50, default: 10)
157-
- `search_mode` (optional): Search mode - "content" for full-text search or "titles" for title-only search (default: "content")
158-
- `limit` (optional): Alternative name for page_size (for compatibility)
159-
- `include_facets` (optional): Whether to include facets in response (default: false to reduce token usage)
164+
- `page` (optional): Page number (default: 1)
165+
- `page_size` (optional): Results per page (default: 10)
166+
- `search_mode` (optional): Search mode (default: content)
167+
- `limit` (optional): Maximum results limit
168+
- `include_facets` (optional): Include facets in results (default: false)
160169

161170
### 2. `pia_search_content_facets`
162171

163172
**Purpose:** Get available facets (filter values) for the PIA database content search.
164173

165-
**Description:** This can help understand what filter values are available before performing content searches. Supports complex OData filtering with boolean logic, operators, and grouping.
174+
**Description:** This can help understand what filter values are available before performing content searches. Major data sources include: Department of Justice (198k+ docs), Congress.gov (29k+ docs), Oversight.gov (22k+ docs), CRS (22k+ docs), GAO (10k+ docs).
166175

167176
**Parameters:**
168-
- `query` (optional): Optional query to get facets for (if empty, gets all facets, default: "")
177+
- `query` (optional): Optional query to get facets for (default: "")
169178
- `filter` (optional): Optional OData filter expression
170179

171180
### 3. `pia_search_titles`
172181

173182
**Purpose:** Search the Program Integrity Alliance (PIA) database for document titles only.
174183

175-
**Description:** Returns document titles and metadata without searching the full content. Useful for finding specific documents by title or discovering available documents. Supports complex OData filtering with boolean logic, operators, and grouping.
184+
**Description:** Returns document titles and metadata without searching the full content. Useful for finding specific documents by title or discovering available documents. Major data sources include: Department of Justice (198k+ docs), Congress.gov (29k+ docs), Oversight.gov (22k+ docs), CRS (22k+ docs), GAO (10k+ docs).
176185

177186
**Parameters:**
178187
- `query` (required): Search query text (searches document titles only)
179188
- `filter` (optional): OData filter expression supporting complex boolean logic
180-
- `page` (optional): Page number (1-based, default: 1)
181-
- `page_size` (optional): Number of results per page (max 50, default: 10)
182-
- `limit` (optional): Alternative name for page_size (for compatibility)
183-
- `include_facets` (optional): Whether to include facets in response (default: false to reduce token usage)
189+
- `page` (optional): Page number (default: 1)
190+
- `page_size` (optional): Results per page (default: 10)
191+
- `limit` (optional): Maximum results limit
192+
- `include_facets` (optional): Include facets in results (default: false)
184193

185194
### 4. `pia_search_titles_facets`
186195

187196
**Purpose:** Get available facets (filter values) for the PIA database title search.
188197

189-
**Description:** This can help understand what filter values are available before performing title searches. Supports complex OData filtering with boolean logic, operators, and grouping.
198+
**Description:** This can help understand what filter values are available before performing title searches. Major data sources include: Department of Justice (198k+ docs), Congress.gov (29k+ docs), Oversight.gov (22k+ docs), CRS (22k+ docs), GAO (10k+ docs).
190199

191200
**Parameters:**
192-
- `query` (optional): Optional query to get facets for (if empty, gets all facets, default: "")
201+
- `query` (optional): Optional query to get facets for (default: "")
193202
- `filter` (optional): Optional OData filter expression
194203

204+
### Agency-Specific Search Tools
205+
206+
### 5. `pia_search_content_gao`
207+
208+
**Purpose:** Search for GAO document content and recommendations.
209+
210+
**Description:** This tool automatically filters results to only include documents from the Government Accountability Office (GAO). Returns comprehensive results with full citation information and clickable links for proper attribution.
211+
212+
**Parameters:**
213+
- `query` (required): Search query text
214+
- `filter` (optional): OData filter expression (SourceDocumentDataSource is automatically set to 'GAO')
215+
- `page` (optional): Page number (default: 1)
216+
- `page_size` (optional): Results per page (default: 10)
217+
- `search_mode` (optional): Search mode (default: content)
218+
- `limit` (optional): Maximum results limit
219+
- `include_facets` (optional): Include facets in results (default: false)
220+
221+
### 6. `pia_search_content_oig`
222+
223+
**Purpose:** Search for OIG document content and recommendations.
224+
225+
**Description:** This tool automatically filters results to only include documents from Office of Inspector General (OIG) sources. Returns comprehensive results with full citation information and clickable links for proper attribution.
226+
227+
**Parameters:**
228+
- `query` (required): Search query text
229+
- `filter` (optional): OData filter expression (SourceDocumentDataSource is automatically set to 'OIG')
230+
- `page` (optional): Page number (default: 1)
231+
- `page_size` (optional): Results per page (default: 10)
232+
- `search_mode` (optional): Search mode (default: content)
233+
- `limit` (optional): Maximum results limit
234+
- `include_facets` (optional): Include facets in results (default: false)
235+
236+
### 7. `pia_search_content_crs`
237+
238+
**Purpose:** Search for CRS document content and recommendations.
239+
240+
**Description:** This tool automatically filters results to only include documents from Congressional Research Service (CRS). Returns comprehensive results with full citation information and clickable links for proper attribution.
241+
242+
**Parameters:**
243+
- `query` (required): Search query text
244+
- `filter` (optional): OData filter expression (SourceDocumentDataSource is automatically set to 'CRS')
245+
- `page` (optional): Page number (default: 1)
246+
- `page_size` (optional): Results per page (default: 10)
247+
- `search_mode` (optional): Search mode (default: content)
248+
- `limit` (optional): Maximum results limit
249+
- `include_facets` (optional): Include facets in results (default: false)
250+
251+
### 8. `pia_search_content_doj`
252+
253+
**Purpose:** Search for Department of Justice document content and recommendations.
254+
255+
**Description:** This tool automatically filters results to only include documents from the Department of Justice. Returns comprehensive results with full citation information and clickable links for proper attribution.
256+
257+
**Parameters:**
258+
- `query` (required): Search query text
259+
- `filter` (optional): OData filter expression (SourceDocumentDataSource is automatically set to 'Department of Justice')
260+
- `page` (optional): Page number (default: 1)
261+
- `page_size` (optional): Results per page (default: 10)
262+
- `search_mode` (optional): Search mode (default: content)
263+
- `limit` (optional): Maximum results limit
264+
- `include_facets` (optional): Include facets in results (default: false)
265+
266+
### 9. `pia_search_content_congress`
267+
268+
**Purpose:** Search for Congress.gov document content and recommendations.
269+
270+
**Description:** This tool automatically filters results to only include documents from Congress.gov. Returns comprehensive results with full citation information and clickable links for proper attribution.
271+
272+
**Parameters:**
273+
- `query` (required): Search query text
274+
- `filter` (optional): OData filter expression (SourceDocumentDataSource is automatically set to 'Congress.gov')
275+
- `page` (optional): Page number (default: 1)
276+
- `page_size` (optional): Results per page (default: 10)
277+
- `search_mode` (optional): Search mode (default: content)
278+
- `limit` (optional): Maximum results limit
279+
- `include_facets` (optional): Include facets in results (default: false)
280+
281+
### ChatGPT Connector Tools
282+
283+
### 10. `search`
284+
285+
**Purpose:** Simple search interface for ChatGPT Connectors.
286+
287+
**Description:** Search the Program Integrity Alliance (PIA) database and return a list of potentially relevant search results with titles, snippets, and URLs for citation. This endpoint is one of the supported for OpenAI's MCP spec when integrating ChatGPT Connectors.
288+
289+
**Parameters:**
290+
- `query` (required): A search query string to find relevant documents in the PIA database
291+
292+
### 11. `fetch`
293+
294+
**Purpose:** Document retrieval by ID for ChatGPT Connectors.
295+
296+
**Description:** Retrieve the full contents of a specific document from the PIA database using its unique identifier. This endpoint is one of the supported for OpenAI's MCP spec when integrating ChatGPT Connectors.
297+
298+
**Parameters:**
299+
- `id` (required): A unique identifier for the document to retrieve
300+
195301
## Search Modes
196302

197303
Comprehensive search with OData filtering and faceting. The `filter` parameter uses standard [OData query syntax](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html).

0 commit comments

Comments
 (0)