notion_retrieve_user
Retrieve specific user details from Notion using their user ID, supporting both JSON and markdown response formats for different use cases.
Instructions
Retrieve a specific user by user_id in Notion. Note: This function requires upgrading to the Notion Enterprise plan and using an Organization API key to avoid permission errors.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | The ID of the user to retrieve.It should be a 32-character string (excluding hyphens) formatted as 8-4-4-4-12 with hyphens (-). | |
| format | No | Specify the response format. 'json' returns the original data structure, 'markdown' returns a more readable format. Use 'markdown' when the user only needs to read the page and isn't planning to write or modify it. Use 'json' when the user needs to read the page with the intention of writing to or modifying it. | markdown |
Implementation Reference
- src/server/index.ts:148-156 (handler)Handles the MCP CallToolRequest for 'notion_retrieve_user' by validating the user_id argument and delegating to the NotionClientWrapper's retrieveUser method.case "notion_retrieve_user": { const args = request.params .arguments as unknown as args.RetrieveUserArgs; if (!args.user_id) { throw new Error("Missing required argument: user_id"); } response = await notionClient.retrieveUser(args.user_id); break; }
- src/client/index.ts:141-147 (handler)Executes the core logic of retrieving a specific Notion user by ID via a GET request to the Notion API endpoint /users/{user_id}.async retrieveUser(user_id: string): Promise<UserResponse> { const response = await fetch(`${this.baseUrl}/users/${user_id}`, { method: "GET", headers: this.headers, }); return response.json(); }
- src/types/schemas.ts:182-197 (schema)Defines the MCP Tool object for 'notion_retrieve_user', including name, description, and inputSchema specifying the required 'user_id' parameter.export const retrieveUserTool: Tool = { name: "notion_retrieve_user", description: "Retrieve a specific user by user_id in Notion. **Note:** This function requires upgrading to the Notion Enterprise plan and using an Organization API key to avoid permission errors.", inputSchema: { type: "object", properties: { user_id: { type: "string", description: "The ID of the user to retrieve." + commonIdDescription, }, format: formatParameter, }, required: ["user_id"], }, };
- src/server/index.ts:302-326 (registration)Registers the 'notion_retrieve_user' tool (via schemas.retrieveUserTool) in the list of available tools for the MCP ListToolsRequest handler.server.setRequestHandler(ListToolsRequestSchema, async () => { const allTools = [ schemas.appendBlockChildrenTool, schemas.retrieveBlockTool, schemas.retrieveBlockChildrenTool, schemas.deleteBlockTool, schemas.updateBlockTool, schemas.retrievePageTool, schemas.updatePagePropertiesTool, schemas.listAllUsersTool, schemas.retrieveUserTool, schemas.retrieveBotUserTool, schemas.createDatabaseTool, schemas.queryDatabaseTool, schemas.retrieveDatabaseTool, schemas.updateDatabaseTool, schemas.createDatabaseItemTool, schemas.createCommentTool, schemas.retrieveCommentsTool, schemas.searchTool, ]; return { tools: filterTools(allTools, enabledToolsSet), }; });
- src/types/args.ts:57-60 (schema)TypeScript interface for the arguments of 'notion_retrieve_user', used for type assertion in the handler.export interface RetrieveUserArgs { user_id: string; format?: "json" | "markdown"; }