сценарий-слово
Сервер протокола контекста модели (MCP), созданный с помощью mcp-framework.
Быстрый старт
# Install dependencies
npm install
# Build the project
npm run build
Related MCP server: OmniFocus-MCP
Структура проекта
scenario-word/
├── src/
│ ├── tools/ # MCP Tools
│ │ └── ExampleTool.ts
│ └── index.ts # Server entry point
├── package.json
└── tsconfig.jsonДобавление компонентов
Проект поставляется с примером инструмента в src/tools/ExampleTool.ts . Вы можете добавить больше инструментов с помощью CLI:
# Add a new tool
mcp add tool my-tool
# Example tools you might create:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handlerРазработка инструмента
Пример структуры инструмента:
import { MCPTool } from "mcp-framework";
import { z } from "zod";
interface MyToolInput {
message: string;
}
class MyTool extends MCPTool<MyToolInput> {
name = "my_tool";
description = "Describes what your tool does";
schema = {
message: {
type: z.string(),
description: "Description of this input parameter",
},
};
async execute(input: MyToolInput) {
// Your tool logic here
return `Processed: ${input.message}`;
}
}
export default MyTool;Публикация в npm
Обновите ваш package.json:
Убедитесь, что
nameуникально и соответствует соглашениям об именовании npm.Установить соответствующую
versionДобавьте
description,author,licenseи т. д.Проверьте
bin, чтобы указать на правильный файл записи
Сборка и тестирование локально:
npm run build npm link scenario-word # Test your CLI locallyВойдите в npm (при необходимости создайте учетную запись):
npm loginОпубликуйте свой пакет:
npm publish
После публикации пользователи могут добавить его в свой клиент Claude Desktop (см. ниже) или запустить его с помощью npx.
## Using with Claude Desktop
### Local Development
Add this configuration to your Claude Desktop config file:
**MacOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows**: `%APPDATA%/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"scenario-word": {
"command": "node",
"args":["/absolute/path/to/scenario-word/dist/index.js"]
}
}
}После публикации
Добавьте эту конфигурацию в файл конфигурации Claude Desktop:
MacOS : ~/Library/Application Support/Claude/claude_desktop_config.json Windows : %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"scenario-word": {
"command": "npx",
"args": ["scenario-word"]
}
}
}Сборка и тестирование
Внесите изменения в свои инструменты
Запустите
npm run buildдля компиляцииСервер автоматически загрузит ваши инструменты при запуске.