Skip to content

Commit b3a695c

Browse files
authored
Merge pull request #2 from kj455/chore/ci
chore: ci workflow
2 parents c2ee036 + a4721ac commit b3a695c

File tree

5 files changed

+69
-18
lines changed

5 files changed

+69
-18
lines changed

.github/workflows/ci.yml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
strategy:
14+
matrix:
15+
node-version: [18.x, 20.x]
16+
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Cache node modules
21+
uses: actions/cache@v3
22+
with:
23+
path: ~/.npm
24+
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
25+
restore-keys: |
26+
${{ runner.os }}-node-
27+
28+
- name: Use Node.js ${{ matrix.node-version }}
29+
uses: actions/setup-node@v4
30+
with:
31+
node-version: ${{ matrix.node-version }}
32+
cache: 'npm'
33+
34+
- name: Install dependencies
35+
run: npm i
36+
37+
- name: Check code format
38+
run: npm run format
39+
40+
- name: Type check
41+
run: npm run check
42+
43+
- name: Build
44+
run: npm run build

README.md

+19-13
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,40 @@ A Model Context Protocol (MCP) server implementation that enables AI assistants
1010

1111
The mcp-kibela server provides the following features:
1212

13-
* 🔍 **Note Search**: Search Kibela notes by keywords
14-
* 📝 **My Notes**: Fetch your latest notes
15-
* 📖 **Note Content**: Get note content and comments by ID
16-
* 🔗 **Note by Path**: Get note content by path
17-
****
13+
- 🔍 **Note Search**: Search Kibela notes by keywords
14+
- 📝 **My Notes**: Fetch your latest notes
15+
- 📖 **Note Content**: Get note content and comments by ID
16+
- 🔗 **Note by Path**: Get note content by path
17+
18+
---
19+
1820
## Prerequisites 📋
1921

2022
Before you begin, ensure you have:
2123

22-
* Node.js (v18 or higher)
23-
* MCP Client (Claude Desktop, Cursor, etc.)
24-
* Kibela Access Token ([How to get a token](https://support.kibe.la/hc/ja/articles/360036089931-API%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%81%AE%E5%8F%96%E5%BE%97%E6%96%B9%E6%B3%95%E3%82%92%E6%95%99%E3%81%88%E3%81%A6%E3%81%8F%E3%81%A0%E3%81%95%E3%81%84))
25-
* Git (if building from source)
26-
24+
- Node.js (v18 or higher)
25+
- MCP Client (Claude Desktop, Cursor, etc.)
26+
- Kibela Access Token ([How to get a token](https://support.kibe.la/hc/ja/articles/360036089931-API%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%81%AE%E5%8F%96%E5%BE%97%E6%96%B9%E6%B3%95%E3%82%92%E6%95%99%E3%81%88%E3%81%A6%E3%81%8F%E3%81%A0%E3%81%95%E3%81%84))
27+
- Git (if building from source)
2728

2829
## Installation 🛠️
2930

3031
Choose one of the following installation methods:
3132

3233
### Using Smithery
34+
3335
```bash
3436
npx -y @smithery/cli install @kj455/mcp-kibela --client claude
3537
```
3638

3739
### Using npm Package
40+
3841
```bash
3942
npm install -g @kj455/mcp-kibela
4043
```
4144

4245
### Building from Source
46+
4347
```bash
4448
git clone https://github.com/kj455/mcp-kibela.git
4549
cd mcp-kibela
@@ -70,6 +74,7 @@ Add the following to your `claude_desktop_config.json`:
7074
```
7175

7276
#### If you use asdf
77+
7378
You will need this special configuration:
7479

7580
```json
@@ -92,14 +97,15 @@ You will need this special configuration:
9297
```
9398

9499
#### If you built from source
100+
95101
You will need to modify the command and args like this:
96102

97103
```json
98104
{
99105
"mcpServers": {
100106
"kibela": {
101107
"command": "/bin/bash",
102-
"args": ["-c", "node dist/index.js"],
108+
"args": ["-c", "node dist/index.js"]
103109
// ... other env configurations remain the same
104110
}
105111
}
@@ -122,8 +128,8 @@ Cursor Settings -> Features -> MCP Servers -> Add new MCP server
122128

123129
The following environment variables are required:
124130

125-
* `KIBELA_TEAM`: Your Kibela team name (required)
126-
* `KIBELA_TOKEN`: Your Kibela API token (required)
131+
- `KIBELA_TEAM`: Your Kibela team name (required)
132+
- `KIBELA_TOKEN`: Your Kibela API token (required)
127133

128134
## Contributing
129135

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
"postbuild": "shx chmod +x dist/*.js",
2424
"check": "tsc --noEmit",
2525
"build:watch": "npm run build --watch",
26-
"prepublishOnly": "npm run build"
26+
"prepublishOnly": "npm run build",
27+
"format": "prettier --write ."
2728
},
2829
"dependencies": {
2930
"@graphql-typed-document-node/core": "^3.2.0",

smithery.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#smitheryyaml
2-
name: "@kj455/mcp-kibela"
3-
version: "0.1.9"
4-
description: "A Model Context Protocol (MCP) server implementation for Kibela"
2+
name: '@kj455/mcp-kibela'
3+
version: '0.1.9'
4+
description: 'A Model Context Protocol (MCP) server implementation for Kibela'
55
type: mcp-server
66

77
startCommand:

tsconfig.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
},
1414
"include": ["src/**/*"],
1515
"exclude": ["node_modules", "dist"]
16-
}
16+
}

0 commit comments

Comments
 (0)