MCP Server

The awork MCP (Model Context Protocol) server provides AI assistants and language models with direct access to awork’s API functionality. This enables seamless integration of awork capabilities into AI-powered workflows.

Endpoint

https://api.awork.com/api/v1/mcp

Authentication

The MCP server requires authentication using one of the following methods:

OAuth 2.1 with PKCE

The MCP server supports OAuth 2.1 authentication with Proof Key for Code Exchange (PKCE) for secure authorization flows. This is the recommended approach for applications that can securely handle the OAuth flow.

awork supports Dynamic Client Registration which means clients can register themselves during the configuration process. The MCP server will use the registered client to perform the OAuth flow.

Bearer Token Authentication

If your client does not support Dynamic Client Registration, you need to register a client manually and provide an API key. To register a public API client, see Client Application. You can authenticate using an API key in the Authorization header. The configuration depends on the client you are using. Here is an example of the required header:

1
Authorization: Bearer YOUR_API_KEY

To obtain an API key, see Getting an API key.

Supported Actions

The MCP server provides access to core awork functionality, allowing AI assistants to perform various actions on behalf of users:

Additional Capabilities

The MCP server continues to expand its capabilities. For the most up-to-date list of supported actions, consult the Tools list of the MCP server after connecting to it.

Rate Limiting

The MCP server enforces the same rate limits as the standard awork API. See the Rate Limits documentation for details.

Permissions

Actions performed through the MCP server are subject to the same permission model as the standard API. The authenticated user or API token must have appropriate permissions for the requested operations. Refer to the Permissions documentation for more information.

Examples

Visual Studio Code

In VSCode, add the MCP server to the mcp.json configuration file like this:

1
{
2
	"servers": {
3
		"awork": {
4
			"url": "https://api.awork.com/api/v1/mcp",
5
			"type": "http",
6
			"headers": {
7
				"Authorization": "Bearer ${input:awork-api-key}",
8
				"Content-Type": "application/json",
9
				"Accept": "application/json"
10
			}
11
		}
12
	},
13
	"inputs": [
14
		{
15
			"type": "promptString",
16
			"id": "awork-api-key",
17
			"description": "awork API Key",
18
			"password": true
19
		}
20
	]
21
}

It will then prompt you to enter the awork API Key when starting the server. More details here.

ChatGPT

In ChatGPT, add the MCP server via Settings > Connectors > Create. Use https://api.awork.com/api/v1/mcp as the MCP Server URL and select OAuth as the authentication method. You will then be asked to log in with your awork credentials. Find more details here.

Claude Code

In Claude Code, add the MCP server using the following command:

1
claude mcp add --transport http awork https://api.awork.com/api/v1/mcp

Then launch claude and use the /mcp command, select the awork server, and select Authenticate. You will then be asked to log in with your awork credentials.

Find more details here.

Support

For questions about the MCP server or to report issues:

• Visit the Developer Forum
• Contact support@awork.com
• Refer to the main API documentation for detailed endpoint information
• Find out more about Model Context Protocol (MCP)