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)

설치

  1. 저장소를 복제합니다.

    지엑스피1

  2. 종속성 설치:

    npm install
  3. DeepWriter API 키로 루트 디렉토리에 .env 파일을 만듭니다.

    DEEPWRITER_API_KEY=your_api_key_here
  4. 프로젝트를 빌드하세요:

    npm run build

용법

서버 시작

MCP 서버를 시작합니다.

node build/index.js

서버는 MCP 요청을 stdin에서 수신하고 MCP stdio 전송 사양에 따라 stdout에서 응답합니다.

데스크톱용 Claude에 연결

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를 다시 시작하세요.

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 모듈과 Node16 모듈 확인을 지원하는 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. 매개변수 명명 :

    • 서버는 snake_case( project_id )와 camelCase( projectId ) 매개변수 이름을 모두 지원합니다.

    • 모든 매개변수는 대소문자를 구분합니다.

    • 필수 매개변수는 null이거나 정의되지 않을 수 있습니다.

디버깅

자세한 로그를 보려면 DEBUG 환경 변수를 사용하여 서버를 실행하세요.

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

Claude의 데스크톱 로그는 다음에서 확인할 수 있습니다.

  • 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에는 최소한 한 번의 검토가 필요합니다.

    • 주소 검토 피드백

    • PR을 집중적이고 적절한 크기로 유지하세요.

    • 질문과 의견에 적극적으로 대응하세요

개발 지침

  1. 코드 스타일

    • TypeScript 모범 사례를 따르세요

    • ESLint를 구성에 사용하세요

    • Prettier로 코드 포맷하기

    • MCP 프로토콜 사양을 따르세요

  2. 테스트

    • 새로운 기능에 대한 단위 테스트를 작성하세요

    • 테스트 범위 유지 또는 개선

    • MCP 프로토콜 준수 테스트

    • 여러 Node.js 버전으로 테스트

  3. 선적 서류 비치

    • 사용자 중심 변경 사항에 대한 README.md 업데이트

    • 새 코드에 JSDoc 주석 추가

    • API 문서 업데이트

    • 새로운 기능에 대한 예를 포함하세요

  4. 커밋 메시지

    • 기존 커밋 형식을 따르세요

    • 적절한 경우 참조 문제

    • 커밋을 집중적이고 원자적으로 유지하세요

    • 명확하고 설명적인 메시지를 사용하세요

도움 받기

  • Discord 커뮤니티에 가입하세요

  • 문서를 확인하세요

  • GitHub 토론에서 질문하기

  • 월간 기고자 전화 회의에 참석하세요

보안

  • 서버는 처리하기 전에 모든 입력을 검증합니다.

  • API 키는 오류 메시지에 기록되거나 노출되지 않습니다.

  • stdio 전송은 프로세스 격리를 제공합니다.

  • 모든 외부 API 호출은 HTTPS를 사용합니다.

  • 입력 검증으로 주입 공격 방지

특허

MIT

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