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
docs: update README to reflect all current tools and prompts
- Update tools section with comprehensive descriptions for all 4 tools:
- pia_search_content: Full content search with detailed parameters
- pia_search_content_facets: Content search facet discovery
- pia_search_titles: Title-only search for fast document discovery
- pia_search_titles_facets: Title search facet discovery
- Update prompts section with current prompt names:
- summarization_guidance: Updated from summary_prompt
- search_guidance: Updated from search_prompt with all 4 tools
- Add missing parameters and accurate descriptions
- Include proper defaults and constraints (max 50 results, etc.)
- Improve formatting and organization for better readability
All tools and prompts now accurately documented with current implementation
Copy file name to clipboardExpand all lines: README.md
+70-41Lines changed: 70 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,6 +43,26 @@ If you have any questions, we look forward to hearing from you by raising a ques
43
43
44
44
## 🚀 Quick Start
45
45
46
+
### Getting a PIA API Key
47
+
48
+
1. Got to [https://mcp.programintegrity.org/register](https://mcp.programintegrity.org/register)
49
+
2. Enter your email and a few quick details
50
+
3. You should automatically receive your key
51
+
52
+
### Installing using Docker MCP Toolkit (Recommended)
53
+
54
+
*Note: This is pending PR review to be accepted to catalog*
55
+
56
+
1. Download and run the latest version of [Docker Desktop](https://docs.docker.com/desktop/)
57
+
2. Navigate to 'MCP Toolkit'
58
+
3. Search for 'Program Integrity Alliance'
59
+
4. Add as a server by clicking '+'
60
+
5. Under 'Configuration' enter your key
61
+
6. In 'MCP Toolkit' navigate to 'Clients'
62
+
7. Choose one, eg 'Claude Desktop'
63
+
8. Start your Client
64
+
9. You should now see 'pia_search_content' and other tools
65
+
46
66
### Installing via Smithery
47
67
48
68
To install PIA Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/pia-mcp-server):
@@ -123,49 +143,56 @@ For Docker:
123
143
124
144
## 💡 Available Tools
125
145
126
-
The server provides four main tools:
146
+
The server provides four main tools for searching the Program Integrity Alliance (PIA) database:
127
147
128
148
### 1. `pia_search_content`
129
149
130
-
Comprehensive search tool for querying document content and recommendations in the PIA database.
150
+
**Purpose:**Comprehensive search tool for querying document content and recommendations in the PIA database.
131
151
132
-
**Tool Name:**`pia_search_content`
152
+
**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.
133
153
134
154
**Parameters:**
135
155
-`query` (required): Search query text
136
-
-`filter` (optional): OData filter expression
137
-
-`page` (optional): Page number (default: 1)
138
-
-`page_size` (optional): Results per page (default: 10)
-`page` (optional): Page number (1-based, default: 1)
158
+
-`page_size` (optional): Number of results per page (max 50, default: 10)
159
+
-`search_mode` (optional): Search mode - "content" for full-text search or "titles" for title-only search (default: "content")
160
+
-`limit` (optional): Alternative name for page_size (for compatibility)
161
+
-`include_facets` (optional): Whether to include facets in response (default: false to reduce token usage)
140
162
141
163
### 2. `pia_search_content_facets`
142
164
143
-
Tool for discovering available filter values before performing content searches.
165
+
**Purpose:** Get available facets (filter values) for the PIA database content search.
166
+
167
+
**Description:** This can help understand what filter values are available before performing content searches. Supports complex OData filtering with boolean logic, operators, and grouping.
144
168
145
169
**Parameters:**
146
-
-`query` (optional): Query to get facets for (if empty, gets all facets)
147
-
-`filter` (optional): OData filter expression
170
+
-`query` (optional): Optional query to get facets for (if empty, gets all facets, default: "")
Search document titles only for faster discovery of available documents.
175
+
**Purpose:** Search the Program Integrity Alliance (PIA) database for document titles only.
176
+
177
+
**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.
152
178
153
179
**Parameters:**
154
180
-`query` (required): Search query text (searches document titles only)
155
-
-`filter` (optional): OData filter expression
156
-
-`page` (optional): Page number (default: 1)
157
-
-`page_size` (optional): Results per page (default: 10)
-`page` (optional): Page number (1-based, default: 1)
183
+
-`page_size` (optional): Number of results per page (max 50, default: 10)
184
+
-`limit` (optional): Alternative name for page_size (for compatibility)
185
+
-`include_facets` (optional): Whether to include facets in response (default: false to reduce token usage)
161
186
162
187
### 4. `pia_search_titles_facets`
163
188
164
-
Tool for discovering available filter values before performing title searches.
189
+
**Purpose:** Get available facets (filter values) for the PIA database title search.
190
+
191
+
**Description:** This can help understand what filter values are available before performing title searches. Supports complex OData filtering with boolean logic, operators, and grouping.
165
192
166
193
**Parameters:**
167
-
-`query` (optional): Query to get facets for (if empty, gets all facets)
168
-
-`filter` (optional): OData filter expression
194
+
-`query` (optional): Optional query to get facets for (if empty, gets all facets, default: "")
0 commit comments