Skip to main content
Glama

DeepWriter MCP サーバー

DeepWriter APIと連携するためのモデルコンテキストプロトコル(MCP)サーバー。このサーバーは、標準化されたMCPインターフェースを通じて、DeepWriterプロジェクトのコンテンツを作成、管理、生成するためのツールを提供します。

特徴

  • プロジェクト管理: プロジェクトの作成、一覧表示、更新、削除

  • コンテンツ生成: DeepWriterのAIを使用してプロジェクトのコンテンツを生成します

  • プロジェクトの詳細: プロジェクトの詳細情報を取得します

  • MCP 統合: Claude やその他の MCP 対応 AI アシスタントとシームレスに統合

  • 標準 MCP 機能: MCP プロトコル バージョン 2025-03-26 を実装

  • トランスポートサポート: ローカルプロセス通信用のstdioトランスポート

Related MCP server: HexagonML ModelManager MCP Server

前提条件

  • Node.js (v17以上)

  • npm (v6以上)

  • DeepWriter APIキー

  • MCP 互換クライアント (例: Claude for Desktop)

インストール

  1. リポジトリをクローンします。

    git clone https://github.com/yourusername/deepwriter-mcp.git
    cd deepwriter-mcp
  2. 依存関係をインストールします:

    npm install
  3. DeepWriter API キーを使用して、ルート ディレクトリに.envファイルを作成します。

    DEEPWRITER_API_KEY=your_api_key_here
  4. プロジェクトをビルドします。

    npm run build

使用法

サーバーの起動

MCP サーバーを起動します。

node build/index.js

サーバーは、MCP stdio トランスポート仕様に従って、stdin で MCP 要求をリッスンし、stdout で応答します。

Claude for Desktop への接続

Claude for Desktop で DeepWriter MCP サーバーを使用するには:

  1. Claude for Desktop の構成ファイルを開きます。

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

    • Windows: %APPDATA%\Claude\claude_desktop_config.json

  2. サーバー構成を追加します。

    {
      "mcpServers": {
        "deepwriter": {
          "command": "node",
          "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"],
          "env": {
            "DEEPWRITER_API_KEY": "your_api_key_here"
          }
        }
      }
    }
  3. 新しい構成を読み込むには、Claude for Desktop を再起動します。

MCPプロトコルサポート

このサーバーは、次の機能を備えた MCP プロトコル バージョン 2025-03-26 を実装しています。

  • トランスポート: ローカルプロセス通信用のstdioトランスポート

  • ツール: すべてのDeepWriter API操作を完全にサポート

  • ログ記録: 構成可能なレベルを持つ構造化されたログ記録

利用可能なツール

1. プロジェクトの一覧

DeepWriter アカウントに関連付けられているすべてのプロジェクトを一覧表示します。

{
  "api_key": "your_api_key_here"
}

2. プロジェクトの詳細を取得する

特定のプロジェクトに関する詳細情報を取得します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

3. プロジェクトを作成する

指定されたタイトルとメールで新しいプロジェクトを作成します。

{
  "api_key": "your_api_key_here",
  "title": "Your Project Title",
  "email": "your_email@example.com"
}

4. プロジェクトの更新

指定された変更で既存のプロジェクトを更新します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "updates": {
    "title": "Updated Project Title",
    "prompt": "Updated project prompt",
    "author": "Updated author name",
    "email": "updated@email.com",
    "model": "Updated model name",
    "outline_text": "Updated outline",
    "style_text": "Updated style guide",
    "supplemental_info": "Updated additional information",
    "work_description": "Updated work description",
    "work_details": "Updated work details",
    "work_vision": "Updated work vision"
  }
}

5. 作業を生成する

DeepWriter の AI を使用してプロジェクトのコンテンツを生成します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "is_default": true // Optional, defaults to true
}

6.プロジェクトを削除する

プロジェクトを削除します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

発達

プロジェクト構造

deepwriter-mcp/
├── src/
│   ├── index.ts              # Main entry point and MCP server setup
│   ├── api/
│   │   └── deepwriterClient.ts  # DeepWriter API client
│   └── tools/                # MCP tool implementations
│       ├── createProject.ts
│       ├── deleteProject.ts
│       ├── generateWork.ts
│       ├── getProjectDetails.ts
│       ├── listProjects.ts
│       └── updateProject.ts
├── build/                    # Compiled JavaScript output
├── test-deepwriter-tools.js  # Tool testing script
├── test-mcp-client.js       # MCP client testing script
└── tsconfig.json            # TypeScript configuration

建物

npm run build

これにより、TypeScript コードがbuildディレクトリ内の JavaScript にコンパイルされます。

テスト

提供されているテスト スクリプトを使用して、MCP サーバーをローカルでテストできます。

node test-mcp-client.js

または

node test-deepwriter-tools.js

TypeScriptの設定

このプロジェクトでは、ESモジュールとNode.jsモジュール解決を備えたTypeScriptを使用しています。主なTypeScript設定:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "Node16",
    "moduleResolution": "Node16",
    "outDir": "./build",
    "strict": true
  }
}

トラブルシューティング

よくある問題

  1. APIキーの問題:

    • DeepWriter APIキーが.envファイルに正しく設定されていることを確認してください

    • ツールの引数にAPIキーが正しく渡されているか確認する

    • APIキーに必要な権限があることを確認する

  2. 接続の問題:

    • DeepWriter APIがネットワークからアクセスできることを確認してください

    • 接続をブロックする可能性のあるファイアウォールやプロキシ設定を確認してください

    • ネットワーク接続が安定していることを確認してください

  3. MCP プロトコルの問題:

    • 互換性のあるMCPクライアントを使用していることを確認してください

    • stdioトランスポートが正しく設定されているか確認する

    • クライアントがプロトコルバージョン 2025-03-26 をサポートしていることを確認します

  4. パラメータの命名:

    • サーバーは、スネークケース( project_id )とキャメルケース( projectId )の両方のパラメータ名をサポートしています。

    • すべてのパラメータは大文字と小文字が区別されます

    • 必須パラメータは null または未定義であってはなりません

デバッグ

詳細なログを取得するには、DEBUG 環境変数を使用してサーバーを実行します。

DEBUG=deepwriter-mcp:* node build/index.js

Claude for Desktop のログは次の場所でも確認できます。

  • macOS: ~/Library/Logs/Claude/mcp*.log

  • Windows: %APPDATA%\Claude\logs\mcp*.log

貢献

コミュニティからの貢献を歓迎します!ご協力いただける方法は以下の通りです。

問題の提出

  1. バグレポート

    • GitHubの問題追跡ツールを使用する

    • バグを再現するための詳細な手順を含める

    • 環境の詳細(Node.js のバージョン、OS など)を入力してください。

    • 関連するログとエラーメッセージを含める

    • 提供されているバグレポートテンプレートを使用する

  2. 機能リクエスト

    • GitHubの問題追跡ツールで「機能強化」ラベルを使用する

    • 機能とその使用例を明確に説明する

    • プロジェクトにどのようなメリットがあるのかを説明する

    • 提供されている機能リクエストテンプレートを使用する

  3. セキュリティ問題

    • セキュリティ上の脆弱性については、公開問題を作成しないでください。

    • 代わりにsecurity@deepwriter.comにメールしてください

    • 脆弱性に対処するために協力します

    • 当社は責任ある情報開示慣行に従います

プルリクエスト

  1. 始める前に

    • 重複作業を避けるために既存の問題とPRをチェックする

    • 大きな変更については、まず問題を開いて議論してください

    • コーディング標準とMCP実装ガイドラインを読む

  2. 開発プロセス

    • リポジトリをフォークする

    • mainから新しいブランチを作成する

    • コーディングスタイルと規約に従ってください

    • 新機能のテストを追加する

    • 必要に応じてドキュメントを更新する

  3. PR要件

    • 変更点を明確に説明する

    • リンク関連の問題

    • テストを追加または更新する

    • ドキュメントの更新

    • コミットメッセージの慣例に従う

    • 貢献者ライセンス契約(CLA)に署名する

  4. コードレビュー

    • すべてのPRには少なくとも1回のレビューが必要です

    • レビューのフィードバックに対応する

    • PRを焦点を絞って適切なサイズに保つ

    • 質問やコメントに応答する

開発ガイドライン

  1. コードスタイル

    • TypeScriptのベストプラクティスに従う

    • ESLintの設定を使用する

    • Prettierでコードをフォーマットする

    • MCPプロトコル仕様に従う

  2. テスト

    • 新しい機能のユニットテストを書く

    • テスト範囲を維持または改善する

    • MCPプロトコルコンプライアンスのテスト

    • 複数のNode.jsバージョンでテストする

  3. ドキュメント

    • ユーザー向けの変更については README.md を更新してください

    • 新しいコードに JSDoc コメントを追加する

    • APIドキュメントを更新する

    • 新機能の例を含める

  4. コミットメッセージ

    • 従来のコミット形式に従う

    • 適切な場合の参照問題

    • コミットを集中的かつアトミックに保つ

    • 明確で説明的なメッセージを使用する

ヘルプの取得

  • Discordコミュニティに参加する

  • ドキュメントを確認する

  • GitHubのディスカッションで質問する

  • 毎月の寄稿者向け電話会議にご参加ください

安全

  • サーバーは処理前にすべての入力を検証します

  • APIキーは記録されず、エラーメッセージにも表示されません。

  • stdioトランスポートはプロセス分離を提供する

  • すべての外部API呼び出しはHTTPSを使用します

  • 入力検証によりインジェクション攻撃を防止

ライセンス

マサチューセッツ工科大学

Available Tools

6 tools
createProjectC

Create a new project

ParametersJSON Schema
NameRequiredDescriptionDefault
api_keyYesThe DeepWriter API key for authentication.
emailYesThe email associated with the project.
titleYesThe title for the new project.

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool creates something, implying a write operation, but doesn't mention authentication needs (though the schema covers this), potential side effects, error conditions, or what the response might look like. This is a significant gap for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, clear sentence with zero wasted words. It's appropriately sized and front-loaded, making it easy for an agent to parse quickly without unnecessary elaboration.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a creation tool with no annotations and no output schema, the description is insufficient. It doesn't explain what a 'project' is, what happens after creation, or any behavioral traits beyond the basic action, leaving critical gaps for the agent to operate effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, with all three parameters (api_key, email, title) well-documented in the schema. The description adds no additional parameter information beyond what the schema provides, so it meets the baseline score of 3 for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Create a new project' clearly states the action (create) and resource (project), which is adequate. However, it doesn't differentiate from sibling tools like 'updateProject' or specify what constitutes a 'project' in this context, making it somewhat vague but functional.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives such as 'updateProject' or 'listProjects'. It lacks context about prerequisites, timing, or exclusions, leaving the agent to infer usage from the tool name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

deleteProjectC

Delete a project

ParametersJSON Schema
NameRequiredDescriptionDefault
api_keyYesThe DeepWriter API key for authentication.
project_idYesThe ID of the project to delete.

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries full burden for behavioral disclosure. 'Delete a project' implies a destructive, irreversible mutation, but it doesn't specify authentication needs (implied by api_key param), rate limits, error conditions, or what happens upon success (e.g., confirmation message). For a destructive tool, this is insufficient.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with zero wasted words—'Delete a project' is a clear, front-loaded statement. Every word earns its place, making it efficient for quick understanding, though this conciseness comes at the cost of detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (destructive mutation with no annotations and no output schema), the description is incomplete. It doesn't cover behavioral aspects like irreversibility, authentication requirements, or response format, leaving gaps that could hinder correct agent usage in a context with siblings like 'updateProject'.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with clear descriptions for both parameters (api_key for authentication, project_id for identification). The description adds no additional meaning beyond the schema, but since the schema is comprehensive, a baseline score of 3 is appropriate as it doesn't detract value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Delete a project' clearly states the verb (delete) and resource (project), making the basic purpose understandable. However, it lacks specificity about what 'project' means in this context and doesn't differentiate from sibling tools like 'updateProject' or 'getProjectDetails' beyond the obvious action difference. It's adequate but minimal.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., project must exist), consequences (e.g., irreversible deletion), or when to choose deletion over other operations like updating. With siblings like 'updateProject' and 'deleteProject' available, this gap is significant.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

generateWorkC

Generate content for a project

ParametersJSON Schema
NameRequiredDescriptionDefault
api_keyYesThe DeepWriter API key for authentication.
is_defaultNoWhether to use default settings (optional, defaults to true).
project_idYesThe ID of the project to generate work for.

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Generate content' implies a creation or processing action, but the description doesn't specify whether this is a read-only or destructive operation, what permissions are needed, or any rate limits. It lacks essential behavioral context for safe and effective use.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It is appropriately sized and front-loaded, making it easy to parse quickly, though it lacks depth.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a content generation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what 'content' entails, the format of the output, or any behavioral traits, leaving significant gaps for the agent to operate effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already documents all parameters (api_key, is_default, project_id) with descriptions. The description adds no additional meaning beyond what the schema provides, such as explaining how parameters interact or their impact on content generation. Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Generate content for a project' states a vague purpose with the verb 'generate' and resource 'content for a project', but it lacks specificity about what type of content or how it differs from sibling tools like createProject or updateProject. It doesn't clearly distinguish itself from other project-related operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives such as createProject or updateProject. There are no explicit instructions, prerequisites, or context for usage, leaving the agent to infer based on the tool name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

getProjectDetailsC

Get detailed information about a specific project

ParametersJSON Schema
NameRequiredDescriptionDefault
api_keyYesThe DeepWriter API key for authentication.
project_idYesThe ID of the project to retrieve details for.

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the action but lacks details on permissions, rate limits, error handling, or response format. For a read operation without annotations, this leaves significant gaps in understanding how the tool behaves.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is appropriately sized and front-loaded, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a read operation with no annotations and no output schema, the description is incomplete. It doesn't explain what 'detailed information' includes, potential errors, or how results are structured, leaving the agent with insufficient context for effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema already documents both parameters ('api_key' for authentication and 'project_id' for identification). The description adds no additional meaning beyond what the schema provides, such as format examples or constraints, resulting in a baseline score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'detailed information about a specific project', making the purpose evident. However, it doesn't distinguish this tool from sibling tools like 'listProjects' or 'updateProject' beyond the basic action, missing explicit differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, such as needing a project ID, or contrast it with 'listProjects' for overviews versus details. Without such context, usage is implied but not clarified.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

listProjectsC

List all projects for the authenticated user

ParametersJSON Schema
NameRequiredDescriptionDefault
api_keyYesThe DeepWriter API key for authentication.

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. It states it's a list operation (implied read-only) but doesn't mention pagination, sorting, filtering, rate limits, or what the output looks like. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that states the core purpose without unnecessary words. It's appropriately sized and front-loaded with the essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no annotations, no output schema, and a simple input schema, the description is incomplete. It doesn't explain what the output contains (project list format), whether there are limitations (like max results), or authentication requirements beyond the implied 'authenticated user'. For a tool that likely returns multiple items, more context is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% (the single parameter 'api_key' is fully described in the schema). The description doesn't add any parameter information beyond what the schema provides. According to guidelines, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('List') and resource ('projects') with scope ('all projects for the authenticated user'). It distinguishes from siblings like 'getProjectDetails' (which retrieves a specific project) by indicating it returns all projects. However, it doesn't explicitly differentiate from other list-like operations that might exist in the sibling set.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites like authentication (though implied by 'authenticated user'), nor does it compare with siblings like 'getProjectDetails' for retrieving specific projects. There's no explicit when/when-not usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

updateProjectC

Update an existing project

ParametersJSON Schema
NameRequiredDescriptionDefault
api_keyYesThe DeepWriter API key for authentication.
project_idYesThe ID of the project to update.
updatesYesObject containing fields to update.

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden for behavioral disclosure. 'Update an existing project' implies a mutation operation but doesn't specify permissions required, whether changes are reversible, rate limits, or what happens to fields not included in updates. This leaves significant gaps for an agent to understand the tool's behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with zero wasted words. It's appropriately front-loaded with the core action and resource, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with 3 parameters, no annotations, no output schema, and multiple sibling tools, the description is inadequate. It doesn't explain what the tool returns, how updates are applied, or provide context about when this tool is appropriate versus alternatives. The high schema coverage helps but doesn't compensate for missing behavioral and usage context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all 3 parameters (api_key, project_id, updates) and their nested properties. The description adds no additional parameter semantics beyond what's in the schema, meeting the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Update an existing project' clearly states the action (update) and resource (project), but it's vague about what aspects can be updated and doesn't differentiate from sibling tools like createProject or deleteProject. It provides basic purpose but lacks specificity about scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives like createProject or deleteProject. The description doesn't mention prerequisites (e.g., needing an existing project ID) or contextual factors that would inform tool selection among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 6 tool updatesv1.0.0
    • First observedcreateProject
    • First observeddeleteProject
    • First observedgenerateWork
    • First observedgetProjectDetails
    • First observedlistProjects
    • First observedupdateProject

TDQS

A3.5/5.0

Scored across 6 tools

Disambiguation5/5

Each tool has a clearly distinct purpose with no ambiguity: create/delete/update/list projects, get project details, and generate content are all unique operations. The descriptions clearly differentiate between project management and content generation tasks.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern with clear, descriptive names. The naming convention is uniform throughout the set, making it easy to understand each tool's function at a glance.

Tool Count5/5

Six tools is well-scoped for a project/content generation server. Each tool earns its place with complete CRUD coverage for projects plus dedicated content generation functionality, avoiding both bloat and insufficiency.

Completeness5/5

The tool surface provides complete CRUD coverage for projects (create, read, update, delete, list) plus content generation capabilities. There are no obvious gaps for the stated domain of project-based writing/content creation.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers