Connect AI agents to Microsoft Word

Scalekit connector

The Microsoft Word connector lets your AI agent act in each user's Microsoft Word account. Each user signs in to Microsoft Word once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 10 tools.

Tools: 10
What they doRead · write · destructive: 5 · 4 · 15 read4 write1 destructive
Users sign in with: OAuth
OAuth app: Scalekit's or your own

What you can do

Find documents: list Word documents in OneDrive folders or search by file name and content
Create and update documents: create new Word documents or replace the content of existing ones
Read documents: export a Word document as a PDF and fetch details such as size and last modified date
Organize documents: copy, move, or rename documents across OneDrive folders, or send them to the recycle bin
View version history: list past versions of a document with who changed it and when

Setup

npm install @scalekit-sdk/node dotenv

pip install scalekit-sdk-python python-dotenv

Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Microsoft Word connection
In AgentKit > Connections, create a Microsoft Word connection. The name you give it is the connection_name your code passes. See Configure connections.
Scalekit credentials are available for Microsoft Word, so you don't need to register an OAuth app. To show your own app on the consent screen, use your own credentials instead.
Use your own OAuth app
Register your Scalekit environment with the Microsoft Word connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:
1. Set up auth redirects
  - In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Word and click Create. Copy the redirect URI. It will look like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.
  - Sign into portal.azure.com and go to Microsoft Entra ID → App registrations → New registration.
  - Enter a name for your app.
  - Under Supported account types, select Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts.
  - Under Redirect URI, select Web and paste the redirect URI from step 1. Click Register.
2. Get your client credentials
  - Go to Certificates & secrets → New client secret, set an expiry, and click Add. Copy the Value immediately.
  - From the Overview page, copy the Application (client) ID.
3. Add credentials in Scalekit
  - In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.
  - Enter your credentials:
    
    Client ID (Application (client) ID from Azure)
    
    Client Secret (from Certificates & secrets)
    
    Permissions (scopes — see Microsoft Graph permissions reference)
  - Click Save.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'microsoftword'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize Microsoft Word:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'microsoftword_get_document',
27
  toolInput: { item_id: 'YOUR_ITEM_ID' },
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "microsoftword"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Microsoft Word:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={"item_id":"YOUR_ITEM_ID"},
27
    tool_name="microsoftword_get_document",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

microsoftword_get_documentRetrieve metadata for a Word document (.docx) in OneDrive by item ID.Read-only
Get Word Document Metadata
Retrieve metadata for a Word document (.docx) in OneDrive by item ID. Returns name, size, createdDateTime, lastModifiedDateTime, file hashes/MIME type, parentReference, webUrl, and eTag/cTag. Does not return the document's content — use microsoftword_read_document to export the content as PDF. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
item_idstringrequired
The unique OneDrive item ID of the Word document. Obtain item IDs from microsoftword_list_documents, microsoftword_search_documents, or microsoftword_create_document.
microsoftword_list_document_versionsList the version history of a Word document (.docx) stored in OneDrive.Read-only
List Word Document Versions
List the version history of a Word document (.docx) stored in OneDrive. Returns each version's ID, last-modified time, last-modified-by user, and size. Does not return version content — Microsoft Graph does not expose a way to download historical version bytes for this resource type via this API. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
item_idstringrequired
The unique OneDrive item ID of the Word document whose version history to list. Obtain item IDs from microsoftword_list_documents, microsoftword_search_documents, or microsoftword_create_document.
microsoftword_list_documentsList the children of a OneDrive folder, intended for finding Word (.docx) files.Read-only
List Word Documents in Folder
List the children of a OneDrive folder, intended for finding Word (.docx) files. Use "root" as parent_id to list the top level of the signed-in user's OneDrive. The Graph API returns all item types (files and folders); pass filter with "endswith(name,'.docx')" to narrow results to Word documents only. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
parent_idstringrequired
The OneDrive item ID of the folder to list. Use "root" to list the top level of OneDrive. Obtain folder IDs from microsoftword_get_document or other list operations.
filterstring
Value for the OData $filter query parameter — an expression to narrow results. Example: "endswith(name,'.docx')" returns only Word documents.
orderbystring
Value for the OData $orderby query parameter — the property to sort results by. Example: "name asc" or "lastModifiedDateTime desc".
selectstring
Value for the OData $select query parameter — a comma-separated list of properties to return. Example: "id,name,size,lastModifiedDateTime" reduces response payload.
topinteger
Value for the OData $top query parameter — the maximum number of items to return per page (default: 25).default 25
microsoftword_read_documentExport a Word document (.docx) from OneDrive as a PDF by requesting the file content with the format=pdf conversion parameter.Read-only
Read Word Document as PDF
Export a Word document (.docx) from OneDrive as a PDF by requesting the file content with the format=pdf conversion parameter. Returns the PDF binary of the document. Note: Microsoft Graph converts the document server-side to PDF; it does not return Markdown or plain text. Client-side parsing is required to extract text from the returned PDF. Requires Files.Read or Files.ReadWrite scope.
Inputs
item_idstringrequired
The unique OneDrive item ID of the Word document (.docx) to export as PDF. Obtain item IDs from list drive items, search drive items, or get drive item operations. Example: "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36K".
microsoftword_search_documentsSearch the signed-in user's personal OneDrive for items matching a query string, searching across file names and content.Read-only
Search Word Documents
Search the signed-in user's personal OneDrive for items matching a query string, searching across file names and content. Include "docx" in the query or filter the returned array client-side by name to isolate Word documents, since this endpoint searches all OneDrive item types. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
querystringrequired
Search query string to find Word documents by name or content. Example: "quarterly report docx".
selectstring
Value for the OData $select query parameter — a comma-separated list of properties to return. Example: "id,name,size,webUrl" reduces response payload.
topinteger
Value for the OData $top query parameter — the maximum number of results to return. Accepts values 1–999.
microsoftword_copy_documentCopy a Word document (.docx) in OneDrive to a new parent folder asynchronously.Write
Copy Word Document
Copy a Word document (.docx) in OneDrive to a new parent folder asynchronously. Returns HTTP 202 Accepted with a Location header pointing to a monitor URL; the copy itself completes in the background. Optionally provide a new name for the copy. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
item_idstringrequired
The unique OneDrive item ID of the Word document to copy. Obtain item IDs from microsoftword_list_documents, microsoftword_search_documents, or microsoftword_create_document.
new_parent_idstringrequired
The OneDrive item ID of the destination folder for the copy. Use "root" to copy to the top level of OneDrive.
new_namestring
Optional name for the copied document, including the .docx extension. If omitted, the copy keeps the original name.
microsoftword_create_documentCreate a new Word document (.docx) in OneDrive by initiating a resumable upload session.Write
Create Word Document
Create a new Word document (.docx) in OneDrive by initiating a resumable upload session. Returns an uploadUrl that the caller must use to upload the .docx file bytes via one or more PUT requests. The document is placed under the specified parent folder with the given filename. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
filenamestringrequired
The base name of the Word document to create, without the .docx extension. The extension is appended automatically. Example: "Project Proposal" creates "Project Proposal.docx".
parent_idstringrequired
The OneDrive item ID of the parent folder where the document will be created. Use "root" to create the document at the top level of OneDrive. Obtain folder IDs from list or get drive item operations.
conflict_behaviorstring
Behavior when a file with the same name already exists in the target folder. "fail" aborts and returns an error, "replace" overwrites the existing file, "rename" saves the new document with a different auto-generated name. Default: replace.one of failreplacerenamedefault replace
microsoftword_move_documentMove a Word document (.docx) to a different OneDrive folder, rename it, or both, by PATCHing its parentReference and/or name.Write
Move or Rename Word Document
Move a Word document (.docx) to a different OneDrive folder, rename it, or both, by PATCHing its parentReference and/or name. Provide new_parent_id to move the document, new_name to rename it (include the .docx extension), or both at once. At least one of new_parent_id or new_name must be provided. Requires Files.ReadWrite or Files.ReadWrite.All scope.
- Idempotent
Inputs
item_idstringrequired
The unique OneDrive item ID of the Word document to move or rename. Obtain item IDs from microsoftword_list_documents, microsoftword_search_documents, or microsoftword_create_document.
new_namestring
New name for the document, including the .docx extension. Omit to keep the current name while only moving the document.
new_parent_idstring
The OneDrive item ID of the destination folder. Use "root" to move the document to the top level of OneDrive. Omit to keep the document in its current folder while only renaming it.
microsoftword_update_document_contentOverwrite the content of an existing Word document (.docx) in OneDrive by initiating an upload session against its item ID.Write
Update Word Document Content
Overwrite the content of an existing Word document (.docx) in OneDrive by initiating an upload session against its item ID. Returns an uploadUrl that the caller must use to PUT the replacement .docx file bytes (as one request for files under ~60 MiB, or as sequential byte-range PUTs for larger files) — mirrors microsoftword_create_document but targets an existing item's content instead of creating a new file by name. No request body is required to start the session. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
item_idstringrequired
The unique OneDrive item ID of the existing Word document whose content will be replaced. Obtain item IDs from microsoftword_list_documents, microsoftword_search_documents, or microsoftword_create_document.
microsoftword_delete_documentDelete a Word document (.docx) from OneDrive by item ID.Destructive
Delete Word Document
Delete a Word document (.docx) from OneDrive by item ID. The item is moved to the recycle bin, not permanently purged. On success, returns 204 No Content. Requires Files.ReadWrite or Files.ReadWrite.All scope.
Inputs
item_idstringrequired
The unique OneDrive item ID of the Word document to delete. Obtain item IDs from microsoftword_list_documents, microsoftword_search_documents, or microsoftword_create_document.

Workflows

Proxy API call

Node.js
Python

const result = await actions.request({
  connectionName: 'microsoftword',
  identifier: 'user_123',
  path: '/v1.0/me',
  method: 'GET',
});
console.log(result);

result = actions.request(
    connection_name='microsoftword',
    identifier='user_123',
    path="/v1.0/me",
    method="GET"
)
print(result)

Execute a tool

Node.js
Python

const result = await actions.executeTool({
  connector: 'microsoftword',
  identifier: 'user_123',
  toolName: 'microsoftword_list_documents',
  toolInput: { parent_id: 'root' },
});
console.log(result);

result = actions.execute_tool(
    connection_name='microsoftword',
    identifier='user_123',
    tool_name='microsoftword_list_documents',
    tool_input={'parent_id': 'root'},
)
print(result)

What you can do

Setup

Install the SDK

Set your credentials

Create the Microsoft Word connection

Set up auth redirects

Get your client credentials

Add credentials in Scalekit

Authorize a user and make your first call

Tools

Call it

Returns

Get Word Document Metadata

Inputs

List Word Document Versions

Inputs

List Word Documents in Folder

Inputs

Read Word Document as PDF

Inputs

Search Word Documents

Inputs

Copy Word Document

Inputs

Create Word Document

Inputs

Move or Rename Word Document

Inputs

Update Word Document Content

Inputs

Delete Word Document

Inputs

Workflows

Related: other Files & Documents connectors