@esaio/esa-mcp-server 0.2.0 → 0.2.1

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.
Files changed (3) hide show
  1. package/README.en.md +9 -5
  2. package/README.md +15 -11
  3. package/package.json +1 -1
package/README.en.md CHANGED
@@ -13,6 +13,7 @@ This MCP server provides seamless integration between AI assistants and [esa.io]
13
13
  ## Available Tools
14
14
 
15
15
  ### Team Management
16
+
16
17
  - `esa_get_teams` - Get user's accessible esa teams
17
18
  - `esa_get_team_stats` - Get team statistics (members, posts, comments, stars, watches, active users)
18
19
  - `esa_get_team_tags` - Get all tags used in team posts with count
@@ -26,11 +27,13 @@ This MCP server provides seamless integration between AI assistants and [esa.io]
26
27
  - `esa_update_post` - Update existing post (title, content, tags, category, WIP status)
27
28
 
28
29
  ### Post Actions
30
+
29
31
  - `esa_archive_post` - Archive a post by moving to Archived/ category
30
32
  - `esa_ship_post` - Ship a post (mark as complete by setting wip to false)
31
33
  - `esa_duplicate_post` - Prepare a post for duplication (retrieve name and body_md)
32
34
 
33
35
  ### Comment Management
36
+
34
37
  - `esa_get_comment` - Get a specific comment by ID
35
38
  - `esa_create_comment` - Create a new comment on a post
36
39
  - `esa_update_comment` - Update an existing comment
@@ -39,6 +42,7 @@ This MCP server provides seamless integration between AI assistants and [esa.io]
39
42
  - `esa_get_team_comments` - Get team comments with pagination
40
43
 
41
44
  ### Category Management
45
+
42
46
  - `esa_get_categories` - Get categories and subcategories for a specific path
43
47
  - `esa_get_top_categories` - Get all top-level categories for a team
44
48
  - `esa_get_all_category_paths` - Get all category paths in a team (with post counts, supports filtering)
@@ -46,11 +50,13 @@ This MCP server provides seamless integration between AI assistants and [esa.io]
46
50
  - Filter examples: `prefix: "dev"` for development-related, `match: "api"` for API-related categories
47
51
 
48
52
  ### Attachments
53
+
49
54
  - `esa_get_attachment` - Retrieve an attachment file from esa posts and comments
50
55
  - Returns base64-encoded data for supported images (JPEG, PNG, GIF, WebP) under 30MB
51
56
  - Returns signed URLs (valid for 5 minutes) for other file types, larger images, or when forceSignedUrl is specified
52
57
 
53
58
  ### Help & Documentation
59
+
54
60
  - `esa_get_search_options_help` - Get esa search syntax documentation
55
61
  - `esa_get_markdown_syntax_help` - Get esa Markdown syntax documentation
56
62
  - `esa_search_help` - Search esa documentation for features and terminology
@@ -74,8 +80,8 @@ Add to your MCP client configuration file:
74
80
  ### Required Environment Variables
75
81
 
76
82
  - ESA_ACCESS_TOKEN: Access Token
77
- - Required scopes: `read write` or `admin:comment read:post write:post read:category read:tag read:team read:member`
78
- - [PAT v2](https://docs.esa.io/posts/559) is recommended.
83
+ - Required scopes: `read write` or `admin:comment read:post write:post read:category read:tag read:attachment read:team read:member`
84
+ - [PAT v2](https://docs.esa.io/posts/559) is recommended.
79
85
  - LANG: Language for UI
80
86
 
81
87
  ### Claude Desktop Example
@@ -115,9 +121,7 @@ Add to `claude_desktop_config.json`:
115
121
  "mcpServers": {
116
122
  "esa": {
117
123
  "command": "/Users/your-username/.nodenv/shims/npx",
118
- "args": [
119
- "@esaio/esa-mcp-server"
120
- ],
124
+ "args": ["@esaio/esa-mcp-server"],
121
125
  "env": {
122
126
  "ESA_ACCESS_TOKEN": "your_personal_access_token",
123
127
  "LANG": "en"
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  **日本語** | [English](README.en.md)
6
6
 
7
- esa.io の公式 MCP(Model Context Protocol)サーバー(STDIO Transport版)
7
+ esa.io の公式 MCP(Model Context Protocol)サーバー(STDIO Transport 版)
8
8
 
9
9
  ## 概要
10
10
 
@@ -13,6 +13,7 @@ AI アシスタントと情報共有サービス [esa](https://esa.io) をつな
13
13
  ## 使えるツール
14
14
 
15
15
  ### チーム管理
16
+
16
17
  - `esa_get_teams` - 所属している esa チームの一覧
17
18
  - `esa_get_team_stats` - チームの統計情報(メンバー数、記事数、コメント数など)
18
19
  - `esa_get_team_tags` - チーム内で使われているタグと使用回数
@@ -21,16 +22,18 @@ AI アシスタントと情報共有サービス [esa](https://esa.io) をつな
21
22
  ### 記事管理
22
23
 
23
24
  - `esa_search_posts` - 記事を検索
24
- - `esa_get_post` - 記事IDから記事を取得
25
+ - `esa_get_post` - 記事 ID から記事を取得
25
26
  - `esa_create_post` - 新しい記事を作成(タグ、カテゴリー、WIP ステータス付き)
26
27
  - `esa_update_post` - 記事を更新(タイトル、本文、タグ、カテゴリー、WIP ステータス)
27
28
 
28
29
  ### 記事の操作
30
+
29
31
  - `esa_archive_post` - 記事をアーカイブ(Archived/ カテゴリーへ移動)
30
32
  - `esa_ship_post` - 記事を Ship It!(WIP を外して公開)
31
33
  - `esa_duplicate_post` - 記事を複製するための準備(タイトルと本文を取得)
32
34
 
33
35
  ### コメント管理
36
+
34
37
  - `esa_get_comment` - コメント ID からコメントを取得
35
38
  - `esa_create_comment` - 記事にコメントを追加
36
39
  - `esa_update_comment` - コメントを編集
@@ -39,18 +42,21 @@ AI アシスタントと情報共有サービス [esa](https://esa.io) をつな
39
42
  - `esa_get_team_comments` - チーム全体のコメント一覧(ページング対応)
40
43
 
41
44
  ### カテゴリー管理
45
+
42
46
  - `esa_get_categories` - 指定パス配下のカテゴリー一覧
43
47
  - `esa_get_top_categories` - トップレベルのカテゴリー一覧
44
48
  - `esa_get_all_category_paths` - チーム内の全カテゴリーパス一覧(記事数付き、フィルタリング対応)
45
49
  - カテゴリ構造の把握、整理、統合の計画に最適
46
- - フィルター例: `prefix: "dev"` で開発関連、`match: "api"` でAPI関連を検索
50
+ - フィルター例: `prefix: "dev"` で開発関連、`match: "api"` で API 関連を検索
47
51
 
48
52
  ### 添付ファイル
53
+
49
54
  - `esa_get_attachment` - 記事やコメントの添付ファイルを取得
50
- - サポート形式(JPEG, PNG, GIF, WebP)で30MB以下の画像はbase64エンコードで返却
51
- - その他のファイル、大きな画像、またはforceSignedUrl指定時は署名付きURL(有効期限5分)を返却
55
+ - サポート形式(JPEG, PNG, GIF, WebP)で 30MB 以下の画像は base64 エンコードで返却
56
+ - その他のファイル、大きな画像、または forceSignedUrl 指定時は署名付き URL(有効期限 5 分)を返却
52
57
 
53
58
  ### ヘルプとドキュメント
59
+
54
60
  - `esa_get_search_options_help` - esa の検索構文ヘルプ
55
61
  - `esa_get_markdown_syntax_help` - esa の Markdown 記法ヘルプ
56
62
  - `esa_search_help` - esa のドキュメントから機能や用語を検索
@@ -64,7 +70,7 @@ AI アシスタントと情報共有サービス [esa](https://esa.io) をつな
64
70
  ## プロンプト
65
71
 
66
72
  - `esa_summarize_post` - esa の記事を要約
67
- - 入力: チーム名と記事ID
73
+ - 入力: チーム名と記事 ID
68
74
  - 出力: 記事の構造化された要約
69
75
 
70
76
  ## MCP クライアントの設定
@@ -74,8 +80,8 @@ MCP クライアントの設定ファイルに以下を追加します:
74
80
  ### 用意する環境変数
75
81
 
76
82
  - ESA_ACCESS_TOKEN: アクセストークン
77
- - 必要なスコープ: `read write` または `admin:comment read:post write:post read:category read:tag read:team read:member`
78
- - [PAT v2](https://docs.esa.io/posts/559)を推奨します。
83
+ - 必要なスコープ: `read write` または `admin:comment read:post write:post read:category read:tag read:attachment read:team read:member`
84
+ - [PAT v2](https://docs.esa.io/posts/559)を推奨します。
79
85
  - LANG: UI の言語設定
80
86
 
81
87
  ### Claude Desktop の例
@@ -115,9 +121,7 @@ MCP クライアントの設定ファイルに以下を追加します:
115
121
  "mcpServers": {
116
122
  "esa": {
117
123
  "command": "/Users/your-username/.nodenv/shims/npx",
118
- "args": [
119
- "@esaio/esa-mcp-server"
120
- ],
124
+ "args": ["@esaio/esa-mcp-server"],
121
125
  "env": {
122
126
  "ESA_ACCESS_TOKEN": "your_personal_access_token",
123
127
  "LANG": "ja"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esaio/esa-mcp-server",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Official MCP server for esa.io - STDIO transport version",
5
5
  "main": "bin/index.js",
6
6
  "type": "module",