Tool: search_documents
Searches for knowledge across Google Home documentation and returns the full markdown contents of the matching documents.
The following sample demonstrate how to use curl to invoke the search_documents MCP tool.
| Curl Request |
|---|
curl --location 'https://homedevelopers.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "search_documents", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
Request message for HomeKnowledge.SearchDocuments
SearchDocumentsRequest
| JSON representation |
|---|
{ "query": string, "pageSize": integer, "pageToken": string } |
| Fields | |
|---|---|
query |
Required. The natural language search query (e.g., "How to create an automation?"). |
pageSize |
Optional. The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 10 documents will be returned. The maximum value is 30; values above 30 will be coerced to 30. |
pageToken |
Optional. A page token received from a previous call to retrieve the next set of results. |
Output Schema
Response message for HomeKnowledge.SearchDocuments.
SearchDocumentsResponse
| JSON representation |
|---|
{
"results": [
{
object ( |
| Fields | |
|---|---|
results[] |
The list of search results matching the query. |
nextPageToken |
Token to retrieve the next page. If empty, no more results exist. |
SearchResult
| JSON representation |
|---|
{
"document": {
object ( |
| Fields | |
|---|---|
document |
The matched document resource. |
Document
| JSON representation |
|---|
{ "name": string, "title": string, "markdownContent": string, "sourceUrl": string } |
| Fields | |
|---|---|
name |
Identifier. The unique resource name of the document. Format: documents/{document} |
title |
The title of the document. |
markdownContent |
The full markdown content of the retrieved document. |
sourceUrl |
Optional. Specifies the source URL of the document. |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌