Using the MCP Server

To get the best results from the Vault Documentation MCP Server, treat your queries like highly specific search engine terms. While the search_documentation tool supports natural language, it performs best when you include specific technical identifiers like class names, endpoint names, or component types.

General Formatting Tips

Section link for General Formatting Tips

• Be Surgical: Include the specific "noun" of what you are looking for (for example, Document, Picklist, RecordService).
• Use Contextual Keywords: Add verbs like Create, Update, Query, or Execute to narrow down the documentation section.

Handling Parameters

Section link for Handling Parameters

The search_documentation tool accepts three parameters: source, app_family, and release. You don't set these directly. Your LLM client reads your query and determines the appropriate parameter values to send to the MCP server.

For example, to search the limited release API docs, phrase your query naturally:

Search the limited release API docs for the Generate API access token endpoint details.

Your LLM client sends release="limited" to the MCP server based on the context of your query. The same applies to source and app_family.

Example

Section link for Example

Query

Copy to clipboard

> update single user api uri path parameters

Response

Copy to clipboard

✦ The Update Single User API endpoint uses the following URI path parameter:

  URI Path Parameter

│ Parameter │ Description |
───────────┼───────────────────────────┤
│ {id} │ The system-assigned unique numeric ID of the user. You can also use the keyword me to update the profile of the currently authenticated user. │

  Endpoint Details
   * Method: PUT
   * URI Path: /api/{version}/objects/users/{id}
   * Content-Type: application/x-www-form-urlencoded

  Example Request

   1 curl -X PUT -H "Authorization: {AUTH_VALUE}" \
   2 -H "Content-Type: application/x-www-form-urlencoded" \
   3 -d "user_timezone__v=America/New_York" \
   4 -d "user_title__v=Senior Engineer" \
   5 "https://{server}/api/v26.1/objects/users/25001"

  Pro-Tip
  Since Vault v18.1, users are managed as Object Records. For most updates, it is recommended to use the generic Update Object Record endpoint instead:
  PUT /api/{version}/vobjects/user__sys/{id}