DeepWriter MCP Gateway

An implementation of the Model Context Protocol (MCP) server designed for seamless interaction with the DeepWriter external programming interface. This server exposes robust primitives for project orchestration and AI-driven asset fabrication, standardized through the MCP framework.

Core Capabilities

• Artifact Orchestration: Full Create, Read, Update, and Destroy (CRUD) operations for content generation artifacts (projects).
• Generative Execution: Triggers the DeepWriter AI engine to synthesize new content based on project parameters.
• Metadata Retrieval: Access detailed state information pertaining to any managed artifact.
• AI Ecosystem Interoperability: Provides native interfacing with Claude and other assistants adhering to the MCP specification.
• Protocol Compliance: Adheres strictly to MCP specification version 2025-03-26.
• Communication Channel: Utilizes standard I/O (Stdio) transport for local process communication.

Operational Requirements

• Runtime Environment: Node.js (minimum version 17+)
• Package Manager: npm (minimum version 6+)
• Authentication Credential: A valid DeepWriter API secret key
• Client Interface: An MCP-compliant invoking agent (e.g., Claude Workstation)

Deployment Procedures

Automated Provisioning (Via Smithery)

To automatically register deepwriter-mcp for use with Claude Desktop using Smithery:

bash npx -y @smithery/cli install @deepwriter-ai/deepwriter-mcp --client claude

Manual Setup Steps

1. Obtain the source repository: bash git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcp

2. Resolve dependencies: bash npm install

3. Configure Environment Variables: Create a .env file in the root directory containing your credential:

DEEPWRITER_API_KEY=your_secret_access_token

1. Compile Source Code: bash npm run build

Execution & Client Configuration

Initiating the Gateway Service

Launch the MCP gateway process:

bash node build/index.js

The process will await MCP directives transmitted via standard input and relay results through standard output, following the defined MCP stdio protocol.

Linking with Claude Desktop

To enable the service within Claude for Desktop, modify its configuration file:

• macOS Path: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows Path: %APPDATA%\Claude\claude_desktop_config.json

Inject the following server descriptor:

{ "mcpServers": { "deepwriter_gateway": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"], "env": { "DEEPWRITER_API_KEY": "your_secret_access_token" } } } }

Remember to restart the Claude application to initialize the new service endpoint.

Implemented Protocol Features

This adapter strictly adheres to MCP version 2025-03-26, offering:

• Transport Layer: Stdio handler for localized IPC.
• Tool Set: Exposure of all available DeepWriter API functionalities.
• Auditing: Structured logging capabilities with adjustable verbosity levels.

Available Operations (Tools)

1. enumerateProjects

Fetches a manifest of all artifacts registered under the authenticated account.

{ "auth_token": "your_secret_access_token" }

2. fetchArtifactMetadata

Retrieves granular specifications for a designated project instance.

{ "auth_token": "your_secret_access_token", "artifact_identifier": "unique_project_id_ref" }

3. registerNewArtifact

Provisions a new content generation context.

{ "auth_token": "your_secret_access_token", "designation_label": "New Project Title", "contact_email": "user@domain.com" }

4. reconfigureArtifact

Applies modifications to an existing artifact's parameters.

{ "auth_token": "your_secret_access_token", "artifact_identifier": "unique_project_id_ref", "parameter_adjustments": { "designation_label": "Revised Title", "generation_directive": "Updated instruction set", "creator_identity": "New Author Name", "contact": "revised@domain.com", "model_variant": "New model designation", "structural_map": "Revised blueprint text", "stylistic_guide": "Revised aesthetic manifesto", "ancillary_data": "Updated supplemental context", "task_summary": "Updated work description", "execution_details": "Updated operational specifications", "conceptual_framework": "Updated vision statement" } }

5. executeContentSynthesis

Initiates the AI generation sequence for the specified project.

{ "auth_token": "your_secret_access_token", "artifact_identifier": "unique_project_id_ref", "default_mode_override": true // Optional flag, defaults to true }

6. decommissionArtifact

Permanently removes a project instance.

{ "auth_token": "your_secret_access_token", "artifact_identifier": "unique_project_id_ref" }

Development Lifecycle

Directory Hierarchy

deepwriter-mcp/ ├── src/ │ ├── index.ts # Primary executable and MCP server bootstrap │ ├── integration/ │ │ └── dwClient.ts # Module encapsulating DeepWriter API interactions │ └── protocols/ │ ├── registerArtifact.ts │ ├── decommissionArtifact.ts │ ├── executeSynthesis.ts │ ├── fetchArtifactMetadata.ts │ ├── enumerateProjects.ts │ └── reconfigureArtifact.ts ├── build/ # Output directory for compiled artifacts ├── testUtility-artifactOps.js # Script for testing gateway tools ├── testUtility-mcpLink.js # Script for simulating MCP client interaction └── tsconfig.json # TypeScript compiler configuration file

Compilation

bash npm run build

Generates JavaScript output in the build folder.

Verification

Execute integrated test suites to validate functionality:

bash node testUtility-mcpLink.js

or

bash node testUtility-artifactOps.js

TypeScript Settings

Configuration utilizes modern ES module standards:

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

Issue Resolution Guide

Typical Problems Encountered

1. Credential Validation Failures:
2. Confirm the DeepWriter access token is correctly provisioned in .env.
3. Ensure the token is correctly injected into the tool invocation arguments.

4. Verify the token scope permits the requested operations.

5. Network Accessibility Issues:

6. Check external routing to the DeepWriter service endpoints.
7. Inspect local firewall or proxy configurations that might impede connectivity.

8. Validate network link stability.

9. Protocol Desynchronization:

10. Use a client confirmed to support MCP version 2025-03-26.
11. Validate the stdio transport setup integrity.

12. Verify parameter casing aligns with the expected schema.

13. Argument Mismatch:

14. The server accepts both snake_case (artifact_identifier) and camelCase (artifactIdentifier).
15. All transmitted parameters are case-sensitive.
16. Mandatory inputs must not be absent or null.

Diagnostic Logging

For verbose system tracing, invoke the server with the DEBUG variable set:

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

Client-side diagnostic traces can often be found in: - macOS: ~/Library/Logs/Claude/mcp*.log - Windows: %APPDATA%\Claude\logs\mcp*.log

Community Engagement

We actively encourage external contributions. To participate:

Reporting Anomalies

1. Utilize the official GitHub issue tracker.
2. Detail the steps required to replicate the failure.
3. Include environmental metadata (Node version, OS).
4. Attach relevant log excerpts.

5. Use the designated 'bug' template.

6. Feature Proposals

7. Log requests under the "enhancement" label.
8. Articulate the proposed capability and its intended operational context.
9. Justify its value proposition to the project.

10. Utilize the designated 'feature' template.

11. Vulnerability Disclosure

12. Crucially, do not file a public issue for security concerns.
13. Direct all sensitive findings via encrypted email to security@deepwriter.com.
14. We adhere to responsible disclosure timelines.

Submission Guidelines (Pull Requests)

1. Pre-submission Check
2. Review existing tracker items to prevent redundant effort.
3. For significant architectural changes, initiate discussion via an issue first.

4. Conform to established style guides and MCP implementation mandates.

5. Development Workflow

6. Fork the primary repository.
7. Branch off main for all new work.
8. Maintain code consistency.
9. Ensure comprehensive unit tests accompany new logic.

10. Update documentation for all functional alterations.

11. PR Requirements

12. Provide a succinct summary of modifications.
13. Reference associated issue identifiers.
14. Include verified tests.
15. Document changes where applicable.
16. Adhere to conventional commit standards.

17. Completion of the Contributor License Agreement (CLA) is mandatory.

18. Review Phase

19. All submissions require sign-off from a core maintainer.
20. Address all feedback diligently.
21. Keep submitted PRs modular and narrowly scoped.
22. Maintain prompt communication during review.

Operational Directives

1. Style Conformity
2. Embrace TypeScript best practices.
3. Configure code formatting via ESLint and Prettier.

4. Ensure strict adherence to the documented MCP specifications.

5. Testing Rigor

6. Develop unit tests for all new constructs.
7. Strive to maintain or elevate existing code coverage metrics.
8. Validate conformance against the MCP standard.

9. Test compatibility across specified Node.js runtime versions.

10. Documentation Standards

11. Update README.md for all user-facing functional shifts.
12. Use JSDoc annotations extensively for new code components.
13. Maintain API reference documentation.

14. Provide usage examples for novel features.

15. Commit Discipline

16. Employ the conventional commits specification for messages.
17. Link relevant issue numbers/PR IDs.
18. Commits must be atomic and logically self-contained.
19. Messages must be descriptive and unambiguous.

Support Channels

• Join our designated community Discord server.
• Consult the project documentation portal.
• Initiate dialogue in GitHub Discussions.
• Participate in our regular contributor synchronization meetings.

Security Posture

• Input sanitization is enforced prior to all external API calls.
• Access credentials are never serialized to logs or exposed in failure reports.
• Process separation is maintained via the stdio transport mechanism.
• All external network communication is exclusively secured via HTTPS.
• Robust validation routines mitigate injection vectors.

Licensing

MIT