xero-mcp 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +89 -0
- package/package.json +42 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 John Zhang
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Xero MCP Server
|
|
2
|
+
|
|
3
|
+
This MCP server allows Clients to interact with [Xero Accounting Software](https://www.xero.com).
|
|
4
|
+
|
|
5
|
+
## Get Started
|
|
6
|
+
|
|
7
|
+
1. Make sure [node](https://nodejs.org) and [Claude Desktop](https://claude.ai/download) are installed.
|
|
8
|
+
|
|
9
|
+
2. Create an OAuth 2.0 app in Xero to get a *CLIENT_ID* and *CLIENT_SECRET*.
|
|
10
|
+
|
|
11
|
+
* Create a free Xero user account (if you don't have one)
|
|
12
|
+
* Login to Xero Developer center https://developer.xero.com/app/manage/
|
|
13
|
+
* Click New app
|
|
14
|
+
* Enter a name for your app
|
|
15
|
+
* Select Web app
|
|
16
|
+
* Provide a valid URL (can be anything valid eg. https://www.myapp.com)
|
|
17
|
+
* Enter redirect URI: `http://localhost:5000/callback`
|
|
18
|
+
* Tick to Accept the Terms & Conditions and click Create app
|
|
19
|
+
* On the left-hand side of the screen select Configuration
|
|
20
|
+
* Click Generate a secret
|
|
21
|
+
|
|
22
|
+
3. Modify `claude_desktop_config.json` file
|
|
23
|
+
|
|
24
|
+
```json
|
|
25
|
+
{
|
|
26
|
+
"mcpServers": {
|
|
27
|
+
"xero-mcp": {
|
|
28
|
+
"command": "npx",
|
|
29
|
+
"args": ["-y", "@john-zhang-dev/xero-mcp"],
|
|
30
|
+
"env": {
|
|
31
|
+
"XERO_CLIENT_ID": "YOUR_CLIENT_ID",
|
|
32
|
+
"XERO_CLIENT_SECRET": "YOUR_CLIENT_SECRET",
|
|
33
|
+
"XERO_REDIRECT_URI": "http://localhost:5000/callback"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
4. Restart Claude Desktop
|
|
41
|
+
|
|
42
|
+
## Tools
|
|
43
|
+
|
|
44
|
+
- authenticate
|
|
45
|
+
|
|
46
|
+
Authenticate with Xero using OAuth2
|
|
47
|
+
|
|
48
|
+
- list_accounts
|
|
49
|
+
|
|
50
|
+
List all accounts
|
|
51
|
+
|
|
52
|
+
- list_bank_transactions
|
|
53
|
+
|
|
54
|
+
List all bank transactions
|
|
55
|
+
|
|
56
|
+
- list_contacts
|
|
57
|
+
|
|
58
|
+
List all contacts
|
|
59
|
+
|
|
60
|
+
- list_invoices
|
|
61
|
+
|
|
62
|
+
List all invoices
|
|
63
|
+
|
|
64
|
+
- list_journals
|
|
65
|
+
|
|
66
|
+
List all journals
|
|
67
|
+
|
|
68
|
+
- list_organisations
|
|
69
|
+
|
|
70
|
+
List all organisations
|
|
71
|
+
|
|
72
|
+
- list_payments
|
|
73
|
+
|
|
74
|
+
List all payments
|
|
75
|
+
|
|
76
|
+
- list_quotes
|
|
77
|
+
|
|
78
|
+
List all quotes
|
|
79
|
+
|
|
80
|
+
## WIP Features
|
|
81
|
+
|
|
82
|
+
- Tools that allow new transactions to be added to Xero
|
|
83
|
+
- Docker support
|
|
84
|
+
|
|
85
|
+
If you have additional requirements, please open an issue on this github repository.
|
|
86
|
+
|
|
87
|
+
## License
|
|
88
|
+
|
|
89
|
+
MIT
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "xero-mcp",
|
|
3
|
+
"version": "1.1.0",
|
|
4
|
+
"description": "A Model Context Protocol server allows Clients to interact with Xero",
|
|
5
|
+
"author": "Jianyang Zhang",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"bin": {
|
|
8
|
+
"xero-mcp": "./build/index.js"
|
|
9
|
+
},
|
|
10
|
+
"scripts": {
|
|
11
|
+
"build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
|
|
12
|
+
"start": "tsx src/index.ts"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"build",
|
|
16
|
+
"README.md"
|
|
17
|
+
],
|
|
18
|
+
"keywords": [
|
|
19
|
+
"mcp",
|
|
20
|
+
"xero",
|
|
21
|
+
"modelcontextprotocol",
|
|
22
|
+
"AI",
|
|
23
|
+
"accounting"
|
|
24
|
+
],
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "git+https://github.com/john-zhang-dev/xero-mcp.git"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@modelcontextprotocol/sdk": "^1.7.0",
|
|
31
|
+
"dotenv": "^16.4.7",
|
|
32
|
+
"open": "^10.1.0",
|
|
33
|
+
"xero-node": "^10.0.0",
|
|
34
|
+
"zod": "^3.24.2"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"@types/node": "^22.13.10",
|
|
38
|
+
"tsx": "^4.19.3",
|
|
39
|
+
"typescript": "^5.8.2"
|
|
40
|
+
},
|
|
41
|
+
"license": "MIT"
|
|
42
|
+
}
|