# Search platform guidance

`platform.search_guidance`

Search maintained platform guidance for concise instructions about how the product works. Use live domain tools, not this static guidance, for current workspace facts and authorized links.

[Platform guide](https://docs.levr.ai/mcp/resources/platform.md)

Availability depends on live discovery and your access to the record. Do not infer MCP calls from REST paths.

Operation: read. Required OAuth scopes: mcp.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "max_results": {
      "default": 3,
      "description": "Maximum number of complete guidance topics to return.",
      "maximum": 5,
      "minimum": 1,
      "type": "integer"
    },
    "query": {
      "description": "Platform question or topic to search for.",
      "maxLength": 255,
      "minLength": 2,
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "oneOf": [
    {
      "not": {
        "required": [
          "error"
        ]
      },
      "properties": {
        "ok": {
          "const": true
        }
      },
      "required": [
        "data"
      ]
    },
    {
      "not": {
        "required": [
          "data"
        ]
      },
      "properties": {
        "ok": {
          "const": false
        }
      },
      "required": [
        "error"
      ]
    }
  ],
  "properties": {
    "data": {
      "additionalProperties": false,
      "properties": {
        "results": {
          "description": "Maintained guidance topics that best match the query.",
          "items": {
            "additionalProperties": false,
            "properties": {
              "content": {
                "description": "Maintained instructions for this topic; not live workspace state.",
                "maxLength": 12000,
                "type": "string"
              },
              "title": {
                "description": "Customer-facing guidance topic.",
                "type": "string"
              }
            },
            "required": [
              "title",
              "content"
            ],
            "type": "object"
          },
          "maxItems": 5,
          "type": "array"
        }
      },
      "required": [
        "results"
      ],
      "type": "object"
    },
    "error": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "details": {
          "additionalProperties": true,
          "description": "Optional bounded, agent-safe correction or recovery facts.",
          "type": "object"
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ],
      "type": "object"
    },
    "meta": {
      "additionalProperties": false,
      "properties": {
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "request_id"
      ],
      "type": "object"
    },
    "ok": {
      "description": "Whether the tool completed successfully.",
      "type": "boolean"
    }
  },
  "required": [
    "ok",
    "meta"
  ],
  "type": "object"
}
```
